rack-facebook-method-fix 0.3.0 → 0.4.0

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

@@ -10,4 +10,7 @@ group :development do
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.5.2"
   gem "rcov", ">= 0"
+  gem "json"
+  gem "rspec"
+  gem "rack-test"
 end

data/Gemfile.lock

@@ -1,13 +1,26 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    diff-lcs (1.1.2)
     git (1.2.5)
     jeweler (1.5.2)
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
+    json (1.5.3)
+    rack (1.3.0)
+    rack-test (0.6.0)
+      rack (>= 1.0)
     rake (0.8.7)
     rcov (0.9.9)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
     shoulda (2.11.3)
 
 PLATFORMS
@@ -16,5 +29,8 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.0.0)
   jeweler (~> 1.5.2)
+  json
+  rack-test
   rcov
+  rspec
   shoulda

data/README.rdoc

@@ -14,7 +14,15 @@ In early 2011 Facebook started to send all iframe application requests as POST.
 or
 
   require "rack-facebook-method-fix"
-  use Rack::Facebook::MethodFix, :secret_id => "c561df165eacdd6e32672c9eaee10318"  
+  use Rack::Facebook::MethodFix, :secret_id => "c561df165eacdd6e32672c9eaee10318"
+
+
+You can exclude requests from being processed by adding an exclude option:
+
+  use Rack::Facebook::MethodFix, :exclude => proc { |env| env['PATH_INFO'].match(/^\/admin/) }
+
+This would make sure that no path in the /admin namespace would change from a POST to a GET regardless of the signed_request param.
+
   
 == Contributing to Rack::Facebook::MethodFix
  

data/Rakefile

@@ -27,13 +27,6 @@ Jeweler::Tasks.new do |gem|
 end
 Jeweler::RubygemsDotOrgTasks.new
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
 require 'rcov/rcovtask'
 Rcov::RcovTask.new do |test|
   test.libs << 'test'
@@ -41,8 +34,6 @@ Rcov::RcovTask.new do |test|
   test.verbose = true
 end
 
-task :default => :test
-
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
@@ -52,3 +43,11 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+require 'rspec/core/rake_task'
+desc "Run all specs in spec/"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = "./spec/**/*_spec.rb"
+end
+
+task :default => :spec

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/lib/rack/facebook/method-fix.rb

@@ -8,46 +8,54 @@ module Rack
       end
 
       def call(env)
-        if env["REQUEST_METHOD"] == "POST"
-          request = Request.new(env)
-          if @settings[:secret_id] && request.params["signed_request"]
-            env["REQUEST_METHOD"] = "GET" if signed_request_valid?(@settings[:secret_id], request)          
-          else
-            env["REQUEST_METHOD"] = "GET" if request.params["signed_request"]
+        unless env_excluded?(env)
+          if env["REQUEST_METHOD"] == "POST"
+            request = Request.new(env)
+            if @settings[:secret_id] && request.params["signed_request"]
+              env["REQUEST_METHOD"] = "GET" if signed_request_valid?(@settings[:secret_id], request)
+            else
+              env["REQUEST_METHOD"] = "GET" if request.params["signed_request"]
+            end
           end
         end
         @app.call(env)
       end
-      
+
       # Code adapted from https://github.com/nsanta/fbgraph
       def signed_request_valid?(secret_id, request)
         encoded_signature, payload = request.params["signed_request"].split(".", 2)
         signature = ""
         valid = true
-        
+
         url_decode_64(encoded_signature).each_byte do |byte|
           signature << "%02x" % byte
         end
-        
+
         data = JSON.parse(url_decode_64(payload))
         if data["algorithm"].to_s.upcase != "HMAC-SHA256"
           valid = false
         end
-        
+
         expected_signature = OpenSSL::HMAC.hexdigest("sha256", secret_id, payload)
         if expected_signature != signature
           valid = false
         end
-        
+
         valid
       end
-            
+
       def url_decode_64(string)
         encoded_string = string.gsub("-", "+").gsub("_", "/")
         encoded_string += "=" while !(encoded_string.size % 4).zero?
         Base64.decode64(encoded_string)
       end
-    
+
+      protected
+
+      def env_excluded?(env)
+        @settings[:exclude] && @settings[:exclude].call(env)
+      end
+
     end
   end
 end

data/rack-facebook-method-fix.gemspec

@@ -4,20 +4,21 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{rack-facebook-method-fix}
-  s.version = "0.3.0"
+  s.name = "rack-facebook-method-fix"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mika Tuupola"]
-  s.date = %q{2011-04-13}
-  s.description = %q{In early 2011 Facebook started to send all application requests as POST. This Rack middleware converts POST requests back to GET when applicable.}
-  s.email = %q{tuupola@appelsiini.net}
+  s.date = "2011-09-13"
+  s.description = "In early 2011 Facebook started to send all application requests as POST. This Rack middleware converts POST requests back to GET when applicable."
+  s.email = "tuupola@appelsiini.net"
   s.extra_rdoc_files = [
     "LICENSE",
     "README.rdoc"
   ]
   s.files = [
     ".document",
+    ".rspec",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE",
@@ -27,21 +28,20 @@ Gem::Specification.new do |s|
     "lib/rack-facebook-method-fix.rb",
     "lib/rack/facebook/method-fix.rb",
     "rack-facebook-method-fix.gemspec",
-    "test/helper.rb",
-    "test/test_rack-facebook-method-fix.rb"
+    "spec/rack/facebook/method_fix_spec.rb",
+    "spec/spec_helper.rb"
   ]
-  s.homepage = %q{http://github.com/tuupola/rack-facebook-method-fix}
+  s.homepage = "http://github.com/tuupola/rack-facebook-method-fix"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Fix RESTfull Facebook applications}
+  s.rubygems_version = "1.8.10"
+  s.summary = "Fix RESTfull Facebook applications"
   s.test_files = [
-    "test/helper.rb",
-    "test/test_rack-facebook-method-fix.rb"
+    "spec/rack/facebook/method_fix_spec.rb",
+    "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
@@ -49,17 +49,26 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rack-test>, [">= 0"])
     else
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rack-test>, [">= 0"])
     end
   else
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
     s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rack-test>, [">= 0"])
   end
 end
 

data/spec/rack/facebook/method_fix_spec.rb

@@ -0,0 +1,71 @@
+require File.expand_path('spec_helper', File.join(File.dirname(__FILE__), '../../'))
+
+class MockRackWrapper
+  def initialize(response)
+    @response = response
+  end
+
+  def call(env)
+    @env = env
+    @response
+  end
+
+  def env
+    @env
+  end
+end
+
+describe Rack::Facebook::MethodFix do
+  context "with no exclusions" do
+    before do
+      header = [200, {"Content-type" => "test/plain", "Content-length" => "5"}, ["foo"]]
+      @rack_mock = MockRackWrapper.new(header)
+      facebook = Rack::Facebook::MethodFix.new(@rack_mock)
+      @request = Rack::MockRequest.new(facebook)
+    end
+
+    context "POST requests not from facebook" do
+      it 'should stay as a POST' do
+        @request.post("/", {})
+
+        @rack_mock.env["REQUEST_METHOD"].should == "POST"
+      end
+    end
+
+    context 'POST requests from facebook' do
+      it 'should be changed to GET requests' do
+        @request.post("/", {:params => {"signed_request" => 'nothing'}})
+
+        @rack_mock.env["REQUEST_METHOD"].should == "GET"
+      end
+    end
+  end
+
+  context 'when the middleware is passed an exclusion proc' do
+    before do
+      simple_response = [200, {"Content-type" => "test/plain", "Content-length" => "5"}, ["foo"]]
+      @mock_rack_app = MockRackWrapper.new(simple_response)
+      exclusion_proc = proc { |env| env['PATH_INFO'].match(/^\/admin/) }
+      facebook_method_fix_app = Rack::Facebook::MethodFix.new(@mock_rack_app, :exclude => exclusion_proc)
+      @request = Rack::MockRequest.new(facebook_method_fix_app)
+    end
+
+    it "does not change requests that are not from facebook" do
+      @request.post('/', {})
+      @mock_rack_app.env["REQUEST_METHOD"].should == "POST"
+    end
+
+    context "requests from facebook " do
+      let(:params) { {:params => {"signed_request" => 'nothing'}} }
+      it "changes POSTs to GETs the exclusion proc returns false" do
+        @request.post('/foo', params)
+        @mock_rack_app.env["REQUEST_METHOD"].should == "GET"
+      end
+
+      it "does not change POSTs when the exclusion proc returns true" do
+        @request.post('/admin/foo', params)
+        @mock_rack_app.env["REQUEST_METHOD"].should == "POST"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rack/test'
+require 'rack/mock'
+require File.expand_path('../../lib/rack-facebook-method-fix', __FILE__)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rack-facebook-method-fix
 version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: false
+  hash: 15
+  prerelease: 
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Mika Tuupola
@@ -15,11 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-13 00:00:00 +03:00
-default_executable: 
+date: 2011-09-13 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -28,12 +27,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
   name: shoulda
   prerelease: false
-  version_requirements: *id001
+  type: :development
+  requirement: *id001
 - !ruby/object:Gem::Dependency 
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -44,12 +43,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  type: :development
   name: bundler
   prerelease: false
-  version_requirements: *id002
+  type: :development
+  requirement: *id002
 - !ruby/object:Gem::Dependency 
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -60,12 +59,12 @@ dependencies:
         - 5
         - 2
         version: 1.5.2
-  type: :development
   name: jeweler
   prerelease: false
-  version_requirements: *id003
+  type: :development
+  requirement: *id003
 - !ruby/object:Gem::Dependency 
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -74,10 +73,52 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
   name: rcov
   prerelease: false
-  version_requirements: *id004
+  type: :development
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: json
+  prerelease: false
+  type: :development
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rspec
+  prerelease: false
+  type: :development
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rack-test
+  prerelease: false
+  type: :development
+  requirement: *id007
 description: In early 2011 Facebook started to send all application requests as POST. This Rack middleware converts POST requests back to GET when applicable.
 email: tuupola@appelsiini.net
 executables: []
@@ -89,6 +130,7 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
+- .rspec
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -98,9 +140,8 @@ files:
 - lib/rack-facebook-method-fix.rb
 - lib/rack/facebook/method-fix.rb
 - rack-facebook-method-fix.gemspec
-- test/helper.rb
-- test/test_rack-facebook-method-fix.rb
-has_rdoc: true
+- spec/rack/facebook/method_fix_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/tuupola/rack-facebook-method-fix
 licenses: 
 - MIT
@@ -130,10 +171,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Fix RESTfull Facebook applications
 test_files: 
-- test/helper.rb
-- test/test_rack-facebook-method-fix.rb
+- spec/rack/facebook/method_fix_spec.rb
+- spec/spec_helper.rb

data/test/helper.rb

@@ -1,18 +0,0 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'rack-facebook-method-fix'
-
-class Test::Unit::TestCase
-end

data/test/test_rack-facebook-method-fix.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-class TestRackFacebookMethodFix < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end