buddy 0.6.2 → 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+buddy.tmproj

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in buddy.gemspec
+gemspec

data/README.md

@@ -1,14 +1,52 @@
 # Buddy
 
-Buddy is a lightweight Facebook library for Ruby.
+Buddy is a lightweight Facebook library for Rails 3.
 
 ## Overview
 
 * Support for iFrame Apps
-* Uses signed_request parameters for authentication
+* Uses signed\_request parameters for authentication
 * Supports the Graph API and old REST API
 * Fully compatible with **Rails 3** and **Ruby 1.9.2**
 
+## Install
+
+Add the following to your Gemfile
+
+    gem 'buddy'
+
+or for the latest Git version
+
+    gem 'buddy', :git => 'git://github.com/buddybrand/buddy.git'
+
+Generate and edit config/buddy.yml
+
+    rails generate buddy_config
+
+## Usage
+
+Buddy adds all parameters contained in _signed\_request_ to the params[:fb] hash. See [Canvas Authentication](http://developers.facebook.com/docs/authentication/canvas)
+
+To require the user to install the application add this to your ApplicationController:
+
+    before_filter :ensure_application_is_installed
+
+If the user authorized the application you can do API calls like this:
+
+    # Publish to Graph API:
+    facebook_session.post('/me/feed', :message => 'Hi there!')
+
+    # Reading from Graph API:
+    facebook_session.get('/me')
+
+    # REST API
+    facebook_session.call('users.getInfo')
+
+
+## Todo
+
+* Add tests
+* Add some examples
 
 ## License
 
@@ -22,5 +60,7 @@ Copyright (c) 2010:
 Some concepts and code adapted from [Facebooker](http://github.com/mmangino/facebooker)
 
 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/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/buddy.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "buddy/version"
+
+Gem::Specification.new do |s|
+  s.name        = "buddy"
+  s.version     = Buddy::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ole Riesenberg"]
+  s.email       = ["or@buddybrand.com"]
+  s.homepage    = "http://rubygems.org/gems/buddy"
+  s.summary     = %q{buddybrand's facebook library}
+  s.description = %q{buddybrand's facebook library}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  Gem::Specification.new do |s|
+    s.add_dependency(%q<mini_fb>, [">= 0.2.2"])
+    s.add_dependency(%q<yajl-ruby>, [">= 0"])
+    s.add_dependency(%q<httparty>, [">= 0"])
+  end
+end

data/lib/{rack/facebook.rb → buddy/middleware.rb}

@@ -1,41 +1,10 @@
-module Rack
-  # This Rack middleware checks the signature of Facebook params, and
-  # converts them to Ruby objects when appropiate. Also, it converts
-  # the request method from the Facebook POST to the original HTTP
-  # method used by the client.
-  #
-  # If the signature is wrong, it returns a "400 Invalid Facebook Signature".
-  #
-  # Optionally, it can take a block that receives the Rack environment
-  # and returns a value that evaluates to true when we want the middleware to
-  # be executed for the specific request.
-  #
-  # == Usage
-  #
-  # In your config.ru:
-  #
-  #   require 'rack/facebook'
-  #   use Rack::Facebook, "my_facebook_secret_key"
-  #
-  # Using a block condition:
-  #
-  #   use Rack::Facebook, "my_facebook_secret_key" do |env|
-  #     env['REQUEST_URI'] =~ /^\/facebook_only/
-  #   end
-  #
-
-  module Facebook
-    class RemoteIp
-      def initialize(app)
-        @app = app
-      end
-
-      def call(env)
-        env['REMOTE_ADDR'] = env['X-FB-USER-REMOTE-ADDR'] if env['X-FB-USER-REMOTE-ADDR']
-        @app.call(env)
-      end
-    end
+module Buddy
+  module Middleware
 
+    # This Rack middleware checks the signed_request, and
+    # appends the payload to Rails params.
+    #
+    # If the signature is wrong, it returns a "400 Invalid Facebook Signature".
     class ParamsParser
       def initialize(app, &condition)
         @app = app
@@ -47,6 +16,7 @@ module Rack
 
         request = Rack::Request.new(env)
 
+        request.params["signed_request"] = env['HTTP_X_SIGNED_REQUEST'] if env['HTTP_X_SIGNED_REQUEST'] && !request.params["signed_request"]
         signed_request = request.params["signed_request"]
         if signed_request
           signature, signed_params = signed_request.split('.')
@@ -56,7 +26,7 @@ module Rack
           end
 
           signed_params = Yajl::Parser.new.parse(base64_url_decode(signed_params))
-	  request.params[:fb] = signed_params
+          request.params[:fb] = signed_params
         end
 
         @app.call(env)

data/lib/buddy/rails/controller.rb

@@ -1,7 +1,6 @@
 module Buddy
   module Rails
     module Controller
-      include Buddy::Rails::BackwardsCompatibleParamChecks
       include Buddy::Rails::UrlHelper
 
       def self.included(controller)
@@ -25,6 +24,10 @@ module Buddy
         @facebook_session
       end
 
+      def request_comes_from_facebook?
+        !params[:signed_request].blank? # It already has been verified in middleware, so we can trust it here.
+      end
+
       def application_is_installed?
         !params[:fb][:oauth_token].blank?
       end

data/lib/buddy/rails/controller_extensions.rb

@@ -2,30 +2,10 @@ module ::ActionController
   class Base
     def self.inherited_with_buddy(subclass)
       inherited_without_buddy(subclass)
-      #if subclass.to_s == "ApplicationController"
-        subclass.send(:include, Buddy::Rails::Controller)
-        #subclass.helper Buddy::Rails::Helpers
-      #end
+      subclass.send(:include, Buddy::Rails::Controller)
     end
     class << self
       alias_method_chain :inherited, :buddy
     end
   end
 end
-
-
-# When making get requests, Facebook sends fb_sig parameters both in the query string
-# and also in the post body. We want to ignore the query string ones because they are one
-# request out of date
-# We only do thise when there are POST parameters so that IFrame linkage still works
-#class ActionController::Request
-#  def query_parameters_with_buddy
-#    if request_parameters.blank?
-#      query_parameters_without_buddy
-#    else
-#      (query_parameters_without_buddy||{}).reject {|key,value| key.to_s =~ /^fb_sig/}
-#    end
-#  end
-
-#  alias_method_chain :query_parameters, :buddy
-#end

data/lib/buddy/rails/url_helper.rb

@@ -2,19 +2,16 @@ module Buddy
   module Rails
     module UrlHelper
       def url_for(options = {})
-        options ||= {}
-        opts = case options
-        when Hash
-          options.merge!({ :only_path => true }) #unless options[:canvas] == false
-        else
-          options
-        end
-        url = super(opts)
+        only_path = options[:only_path] || false
+        options.merge!({ :only_path => true }) if options.is_a?(Hash) && options[:canvas] != false
+
+        url = super(options)
 
-        if url.include?("http://")  #todo: make it better
+        if url[0..6] == 'http://'
           url
         elsif options.is_a?(Hash) && options[:canvas] == false
-          "#{Buddy.current_config["callback_url"]}#{url}"
+          base = only_path ? '' : Buddy.current_config["callback_url"]
+          base + url
         else
           "http://apps.facebook.com/#{Buddy.current_config["canvas_page_name"]}#{url}"
         end

data/lib/buddy/railtie.rb

@@ -5,7 +5,7 @@ require 'rails'
 module Buddy
   class Railtie < ::Rails::Railtie
     initializer "buddy.configure_rails_initialization" do |app|
-      app.config.middleware.insert_before(ActionDispatch::ParamsParser, ::Rack::Facebook::ParamsParser)
+      app.config.middleware.insert_before(ActionDispatch::ParamsParser, Buddy::Middleware::ParamsParser)
       ActionView::Helpers::UrlHelper.send(:include, Buddy::Rails::UrlHelper)
       Buddy.logger = ::Rails.logger
     end

data/lib/buddy/version.rb

@@ -0,0 +1,3 @@
+module Buddy
+  VERSION = "1.0.0"
+end

data/lib/buddy.rb

@@ -6,7 +6,7 @@ require 'yajl'
 require 'mini_fb'
 require 'httparty'
 
-require 'rack/facebook'
+require 'buddy/middleware'
 
 require 'buddy/user'
 require 'buddy/session'
@@ -62,7 +62,6 @@ BUDDY = Buddy.load_configuration(buddy_config)
 Buddy.logger = Rails.logger
 Buddy.caller = Buddy::Service::Caller.new
 
-require 'buddy/rails/backwards_compatible_param_checks'
 require 'buddy/rails/url_helper'
 require 'buddy/rails/controller'
 require 'buddy/rails/controller_extensions'

data/lib/generators/buddy_config/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates the buddy config
+
+Example:
+    rails generate buddy_config
+
+    This will create:
+        config/buddy.yml

data/lib/generators/buddy_config/buddy_config_generator.rb

@@ -0,0 +1,7 @@
+class BuddyConfigGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def create_config
+    template 'buddy.yml', File.join('config', "buddy.yml")
+  end
+end

data/lib/generators/buddy_config/templates/buddy.yml

@@ -0,0 +1,23 @@
+development:
+  default:
+    app_id: # your facebook app id
+    secret: # your app secret
+    canvas_page_name: # your canvas name
+    callback_url: # your app callback url, e.g. http://example.com
+    perms: # a comma separated list of required extended permissions, e.g. user_photos,email
+
+test:
+  default:
+    app_id:
+    secret: 
+    canvas_page_name:
+    callback_url:
+    perms:
+
+production:
+  default:
+    app_id:
+    secret:
+    canvas_page_name:
+    callback_url:
+    perms:

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: buddy
 version: !ruby/object:Gem::Version 
-  hash: 3
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
+  - 1
   - 0
-  - 6
-  - 2
-  version: 0.6.2
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Ole Riesenberg
@@ -15,64 +15,27 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-17 00:00:00 +01:00
+date: 2011-02-17 00:00:00 +01:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: mini_fb
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 0
-        - 2
-        - 2
-        version: 0.2.2
-  type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: yajl-ruby
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: httparty
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  version_requirements: *id003
+dependencies: []
+
 description: buddybrand's facebook library
-email: labs@buddybrand.de
+email: 
+- or@buddybrand.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.md
+extra_rdoc_files: []
+
 files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- buddy.gemspec
 - lib/buddy.rb
-- lib/buddy/rails/backwards_compatible_param_checks.rb
+- lib/buddy/middleware.rb
 - lib/buddy/rails/controller.rb
 - lib/buddy/rails/controller_extensions.rb
 - lib/buddy/rails/url_helper.rb
@@ -80,11 +43,13 @@ files:
 - lib/buddy/service.rb
 - lib/buddy/session.rb
 - lib/buddy/user.rb
-- lib/rack/facebook.rb
+- lib/buddy/version.rb
+- lib/generators/buddy_config/USAGE
+- lib/generators/buddy_config/buddy_config_generator.rb
+- lib/generators/buddy_config/templates/buddy.yml
 - test/test_buddy.rb
-- README.md
 has_rdoc: true
-homepage: http://buddybrand.de
+homepage: http://rubygems.org/gems/buddy
 licenses: []
 
 post_install_message: 
@@ -113,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.4.1
 signing_key: 
 specification_version: 3
 summary: buddybrand's facebook library

data/lib/buddy/rails/backwards_compatible_param_checks.rb

@@ -1,33 +0,0 @@
-module Buddy
-  module Rails
-    module BackwardsCompatibleParamChecks
-      def one_or_true( value )
-        case value
-          when String then
-            value == "1"
-          when Numeric then
-            value.to_f == 1.0
-          when TrueClass then
-            true
-          else
-            false
-        end
-      end
-
-      def zero_or_false( value )
-        case value
-          when String then
-            value.empty? || value == "0"
-          when Numeric then
-            value.to_f == 0.0
-          when FalseClass then
-            true
-          when NilClass then
-            true
-          else
-            false
-        end
-      end
-    end
-  end
-end