carrot-facebook 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Carrot Creative
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Carrot::Facebook
+
+Facebook view helpers and signed request handling.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'carrot-facebook'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install carrot-facebook
+
+## Usage
+
+Coming Soon.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/carrot-facebook.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'carrot-facebook/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "carrot-facebook"
+  gem.version       = Carrot::Facebook::VERSION
+  gem.authors       = ["Tom Milewski", "Kyle MacDonald"]
+  gem.email         = ["tmilewski@gmail.com", "kyle@carrotcreative.com"]
+  gem.description   = %q{Facebook view helpers and signed request handling.}
+  gem.summary       = %q{Facebook view helpers and signed request handling.}
+  gem.homepage      = "http://carrotcreative.com/"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "yajl-ruby"
+  gem.add_development_dependency "rails"
+  gem.add_development_dependency "rspec"
+end

data/lib/carrot-facebook.rb

@@ -0,0 +1,4 @@
+require "carrot-facebook/middleware"
+require "carrot-facebook/version"
+require "carrot-facebook/view_helpers"
+require 'carrot-facebook/railtie' if defined?(Rails)

data/lib/carrot-facebook/middleware.rb

@@ -0,0 +1,49 @@
+require 'yajl'
+
+module Carrot
+  module Facebook
+    class Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        request             = Rack::Request.new(env)
+        env[:is_iframe_app] = false
+
+        if request.POST['signed_request']
+          env["REQUEST_METHOD"] = 'GET'
+          env[:is_iframe_app]   = true
+          env[:facebook_data]   = parsed_signed_request(request.POST['signed_request'])
+
+          if env[:facebook_data]
+            if env[:facebook_data][:app_data].present?
+              begin
+                path_override                  = Yajl::Parser.parse(env[:facebook_data][:app_data], symbolize_keys: true) 
+                env['PATH_INFO']               = path_override[:path] if path_override[:path]
+                env[:facebook_data][:app_data] = path_override
+              rescue => e
+                env[:facebook_data][:app_data] = env[:facebook_data][:app_data]
+              end
+            else
+              env[:facebook_data][:app_data] = nil
+            end
+          end
+        end
+
+        @app.call(env)
+      end
+
+      private
+
+      def parsed_signed_request(signed_request)
+        begin
+          p = signed_request.split('.')[1]
+          Yajl::Parser.parse(Base64.decode64(p + "=" * (4 - p.size % 4)), symbolize_keys: true)
+        rescue
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/carrot-facebook/railtie.rb

@@ -0,0 +1,16 @@
+require 'carrot-facebook/middleware'
+require 'carrot-facebook/view_helpers'
+
+module Carrot
+  module Facebook
+    class Railtie < Rails::Railtie
+      initializer "carrot.facebook.middleware" do |app|
+        app.middleware.use Middleware
+      end
+
+      initializer "carrot.facebook.view_helpers" do
+        ActionView::Base.send :include, ViewHelpers
+      end
+    end
+  end
+end

data/lib/carrot-facebook/version.rb

@@ -0,0 +1,5 @@
+module Carrot
+  module Facebook
+    VERSION = "0.0.1"
+  end
+end

data/lib/carrot-facebook/view_helpers.rb

@@ -0,0 +1,71 @@
+include ActionView::Helpers::TagHelper
+
+module Carrot
+  module Facebook
+    module ViewHelpers
+      #extend ActionView::Helpers::AssetTagHelper
+      # Public: Generates a user's Facebook avatar.
+      #
+      # fb_id - The String of the Facebook user's ID.
+      # type  - The Symbol of the desired image size.
+      #         [:square (50x50), :small (50xN), :normal (100xN), :large (200xN)]
+      #
+      # Examples
+      #
+      # fb_avatar('1234567890', :normal)
+      #   # => "//graph.facebook.com/1234567890/picture?type=normal"
+      #
+      # Returns the generated Facebook URL.
+      def fb_avatar(fb_id = nil, type = :square)
+        if fb_id
+          "//graph.facebook.com/#{fb_id}/picture?type=#{type}"
+        end
+      end
+
+      # Public: Display a user's Facebook avatar.
+      #
+      # fb_id - The String of the Facebook user's ID.
+      # type  - The Symbol of the desired image size.
+      #         [:square (50x50), :small (50xN), :normal (100xN), :large (200xN)]
+      #
+      # Examples
+      #
+      # fb_avatar_tag('1234567890', :normal)
+      #   # => '<img alt="Facebook Avatar for User 1234567890" src="//graph.facebook.com/1234567890/picture?type=normal" />'
+      #
+      # Returns the image tag for the Facebook user's avatar.
+      def fb_avatar_tag(fb_id = nil, type = :square)
+        if fb_id
+          tag(:img, src: fb_avatar(fb_id, type), alt: "Facebook Avatar for User #{fb_id}")
+        end
+      end
+
+      # Public: Generate Facebook's Javascript
+      #
+      # options - A Hash potentially consisting of two keys:
+      #           app_id - A String denoting the Facebook App ID (Also accepts ENV["FACEBOOK_APP_ID"])
+      #           xfbml  - A Boolean denoting whether XFBML should be rendered upon pageload
+      #
+      # Examples
+      #
+      #   fb_js
+      #   fb_js(app_id: '1234567890')
+      #   fb_js(xfbml: false)
+      #   fb_js(app_id: '1234567890', xfbml: false)
+      #
+      # Returns and initializes the Facebook Javascript SDK
+      def fbjs(*options)
+        opts = { :app_id => ENV['FACEBOOK_APP_ID'], :xfbml => true }
+        opts.merge!(options.first) unless options.empty?
+
+        %Q{
+          <div id="fb-root"></div>'
+          <script src="//connect.facebook.net/en_US/all.js"></script>
+          <script>
+            FB.init({ appId: '#{opts[:app_id]}', xfbml: '#{opts[:xfbml]}' });
+          </script>
+        }
+      end
+    end
+  end
+end

data/spec/middleware_spec.rb

@@ -0,0 +1,156 @@
+require 'spec_helper'
+
+describe Carrot::Facebook::Middleware do
+  before(:all) do
+    @headers              = { 'Content-Type' => 'text/html' }
+    @app                  = lambda { |env| [200, @headers, []] }
+    @valid_facebook_data  = {
+                              algorithm: 'HMAC-SHA256',
+                              issued_at: 1331665894,
+                              page: {
+                                id: '137739982942274',
+                                liked: false,
+                                admin: true
+                              },
+                              user: {
+                                country: 'us',
+                                locale: 'en_US',
+                                age: {
+                                  min: 21
+                                }
+                              }
+                            }
+  end
+
+  context 'when a normal GET request is received' do
+    before(:all) do
+      @request  = Rack::MockRequest.env_for('/', lint: true, fatal: true,  method: 'GET')
+      @response = Carrot::Facebook::Middleware.new(@app).call(@request)
+    end
+
+    it 'should be a GET request' do
+      expect(@request['REQUEST_METHOD']).to eq 'GET'
+    end
+
+    it 'should keep the headers intact' do
+      expect(@response[1]).to eq @headers
+    end
+
+    it 'should be successful' do
+      expect(@response[0]).to eq 200
+    end
+
+    it 'should not be considered a canvas application' do
+      expect(@request[:is_iframe_app]).to be_false
+    end
+  end
+
+  context "when a normal POST request is received" do
+    before(:all) do
+      @request  = Rack::MockRequest.env_for('/', lint: true, fatal: true, method: 'POST')
+      @response = Carrot::Facebook::Middleware.new(@app).call(@request)
+    end
+
+    it 'should be a POST request' do
+      expect(@request['REQUEST_METHOD']).to eq 'POST'
+    end
+
+    it 'should keep the headers intact' do
+      expect(@response[1]).to eq @headers
+    end
+
+    it 'should be successful' do
+      expect(@response[0]).to eq 200
+    end
+
+    it 'should not be considered a canvas application' do
+      expect(@request[:is_iframe_app]).to be_false
+    end
+  end
+
+  context "when is a canvas app and sends an invalid signed_request" do
+    before(:all) do
+      @signed_request = 'signed_request=kUbujwbyaKAS3EMLSolZki1mJtuzY5-XUrchNN.eyJhbGdvcml0aG0iORtaW4iOnRydWV9LCJ1c2VyIjp7ImNvdW50cnkiOiJ1cyIsImxvY2FsZSI6ImVuX1VTIiwiYWdlIjp7Im1pbiI6MjF9f'
+      @request        = Rack::MockRequest.env_for('/', lint: true, fatal: true,  method: 'POST', input: @signed_request)
+      @response       = Carrot::Facebook::Middleware.new(@app).call(@request)
+    end
+
+    it 'should be converted to a GET request' do
+      expect(@request['REQUEST_METHOD']).to eq 'GET'
+    end
+
+    it 'should keep the headers intact' do
+      expect(@response[1]).to eq @headers
+    end
+
+    it 'should be successful' do
+      expect(@response[0]).to eq 200
+    end
+
+    it 'should not be considered a canvas application' do
+      expect(@request[:is_iframe_app]).to be_true
+    end
+
+    it 'should correctly set :facebook_data' do
+      expect(@request[:facebook_data]).to be_nil
+    end
+  end
+
+  #pending 'test invalid app data'
+
+  context "when is a canvas app and sends a valid signed_request" do
+    before(:all) do
+      @signed_request = 'signed_request=kUbujwbyaKAS3EMLSolZki1mJtuzY5-XUrchNN3MVyI.eyJhbGdvcml0aG0iOiJITUFDLVNIQTI1NiIsImlzc3VlZF9hdCI6MTMzMTY2NTg5NCwicGFnZSI6eyJpZCI6IjEzNzczOTk4Mjk0MjI3NCIsImxpa2VkIjpmYWxzZSwiYWRtaW4iOnRydWV9LCJ1c2VyIjp7ImNvdW50cnkiOiJ1cyIsImxvY2FsZSI6ImVuX1VTIiwiYWdlIjp7Im1pbiI6MjF9fX0'
+      @request        = Rack::MockRequest.env_for('/', lint: true, fatal: true,  method: 'POST', input: @signed_request)
+      @response       = Carrot::Facebook::Middleware.new(@app).call(@request)
+    end
+
+    it 'should be converted to a GET request' do
+      expect(@request['REQUEST_METHOD']).to eq 'GET'
+    end
+
+    it 'should keep the headers intact' do
+      expect(@response[1]).to eq @headers
+    end
+
+    it 'should be successful' do
+      expect(@response[0]).to eq 200
+    end
+
+    it 'should not be considered a canvas application' do
+      expect(@request[:is_iframe_app]).to be_true
+    end
+
+    it 'should correctly set :facebook_data' do
+      expect(@request[:facebook_data]).to eq @valid_facebook_data.merge({ issued_at: 1331665894, app_data: nil })
+    end
+  end
+
+  context "when is a canvas app and sends a valid signed_request with app_data" do
+    before(:all) do
+      @signed_request = 'signed_request=PGQuysjAoFJBxu2Me_HizoVv8BdiPdm5wBhkcdHZaR0.eyJhbGdvcml0aG0iOiJITUFDLVNIQTI1NiIsImFwcF9kYXRhIjoie1wicGF0aFwiOlwiXC9wYWdlXC90ZXJtc1wifSIsImlzc3VlZF9hdCI6MTMzMTY2OTE4NSwicGFnZSI6eyJpZCI6IjEzNzczOTk4Mjk0MjI3NCIsImxpa2VkIjpmYWxzZSwiYWRtaW4iOnRydWV9LCJ1c2VyIjp7ImNvdW50cnkiOiJ1cyIsImxvY2FsZSI6ImVuX1VTIiwiYWdlIjp7Im1pbiI6MjF9fX0'
+      @request        = Rack::MockRequest.env_for('/', lint: true, fatal: true,  method: 'POST', input: @signed_request)
+      @response       = Carrot::Facebook::Middleware.new(@app).call(@request)
+    end
+
+    it 'should be converted to a GET request' do
+      expect(@request['REQUEST_METHOD']).to eq 'GET'
+    end
+
+    it 'should keep the headers intact' do
+      expect(@response[1]).to eq @headers
+    end
+
+    it 'should be successful' do
+      expect(@response[0]).to eq 200
+    end
+
+    it 'should not be considered a canvas application' do
+      expect(@request[:is_iframe_app]).to be_true
+    end
+
+    it 'should correctly set :facebook_data' do
+      expect(@request[:facebook_data]).to eq @valid_facebook_data.merge({ issued_at: 1331669185, app_data: { path: '/page/terms' } })
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require "rails/all"
+require "carrot-facebook"
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter = :documentation
+end

data/spec/view_helper_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+#include Carrot::Facebook::ViewHelpers
+#include ActionView::Helpers::TagHelper
+
+#require 'action_view'
+#require 'active_support'
+
+include Carrot::Facebook::ViewHelpers
+#include ActionView::Helpers
+#include ActionView::Helpers::TagHelper
+
+describe Carrot::Facebook::ViewHelpers, :type => :helper do
+  let(:helper) { Carrot::Facebook::ViewHelpers }
+
+  context "#fb_avatar" do
+    it "should output a default URL with a 'square' format" do
+      output = helper.fb_avatar('tmilewski')
+      expect(output).to match /\?type=square\z/
+    end
+
+    it "should output a URL for a 'large' format" do
+      output = helper.fb_avatar('tmilewski', :large)
+      expect(output).to match /\?type=large\z/
+    end
+
+    it "should accept a Facebook ID as an Integer and output a formatted URL" do
+      output = helper.fb_avatar(8201087)
+      expect(output).to match /.com\/8201087\//
+    end
+
+    it "should accept a Facebook ID as a String and output a formatted URL" do
+      output = helper.fb_avatar('tmilewski')
+      expect(output).to match /.com\/tmilewski\//
+    end
+
+    it "should not raise an error if a Facebook ID isn't provided" do
+      expect(helper.fb_avatar).to_not raise_error(ArgumentError)
+    end
+
+    it "should return nil if a Facebook ID isn't provided" do
+      expect(helper.fb_avatar).to be_nil
+    end
+  end
+
+  context "#fb_avatar_tag" do
+    it "should output the URL within an image tag" do
+      output = helper.fb_avatar_tag('tmilewski')
+      expect(output.to_str).to eq '<img alt="Facebook Avatar for User tmilewski" src="//graph.facebook.com/tmilewski/picture?type=square" />'
+    end
+
+    it "should not raise an error if a Facebook ID isn't provided" do
+      expect(helper.fb_avatar_tag).to_not raise_error(ArgumentError)
+    end
+
+    it "should return nil if a Facebook ID isn't provided" do
+      expect(helper.fb_avatar_tag).to be_nil
+    end
+  end
+
+  context "#fb_js" do
+    it "should output the correct JS using ENV variables" do
+      ENV.stub(:[]).with("FACEBOOK_APP_ID").and_return("asdf")
+      output = helper.fbjs
+      expect(output).to match /appId: 'asdf'/
+      expect(output).to match /xfbml: 'true'/
+    end
+
+    it "should allow an override of the ENV variable" do
+      ENV.stub(:[]).with("FACEBOOK_APP_ID").and_return("asdf")
+      output = helper.fbjs(:app_id => "qwerty")
+      expect(output).to match /appId: 'qwerty'/
+    end
+
+    it "should allow a user to disable XFBML rendering" do
+      output = helper.fbjs(:app_id => "qwerty", :xfbml => false)
+      expect(output).to match /appId: 'qwerty'/
+      expect(output).to match /xfbml: 'false'/
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: carrot-facebook
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tom Milewski
+- Kyle MacDonald
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: &70121394753180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70121394753180
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70121394752400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70121394752400
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70121394745980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70121394745980
+description: Facebook view helpers and signed request handling.
+email:
+- tmilewski@gmail.com
+- kyle@carrotcreative.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- carrot-facebook.gemspec
+- lib/carrot-facebook.rb
+- lib/carrot-facebook/middleware.rb
+- lib/carrot-facebook/railtie.rb
+- lib/carrot-facebook/version.rb
+- lib/carrot-facebook/view_helpers.rb
+- spec/middleware_spec.rb
+- spec/spec_helper.rb
+- spec/view_helper_spec.rb
+homepage: http://carrotcreative.com/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Facebook view helpers and signed request handling.
+test_files:
+- spec/middleware_spec.rb
+- spec/spec_helper.rb
+- spec/view_helper_spec.rb