facebook_party 0.1.0

data/README.rdoc

@@ -0,0 +1,60 @@
+= FacebookParty
+
+I needed a simple wrapper for the Facebook REST API. HTTParty to the rescue!
+
+<tt>method_missing</tt> magic is used to handle any api method available now and in the future.
+
+== Installation
+
+    sudo gem install facebook_party
+
+== Usage
+
+    fb = FacebookParty(API_KEY, SECRET)
+    # call this method: http://wiki.developers.facebook.com/index.php/Auth.createToken
+    response = fb.auth.createToken
+
+== Feedback
+
+I'd love to hear from you if you have suggestions for improvement, bug fixes,
+or whatever. Email me at tim@timmorgan.org or fork the project and send a
+pull request.
+
+To run the tests, do this:
+
+    FACEBOOK_API_KEY="YOURKEY" \
+    FACEBOOK_API_SECRET="YOURSECRET" \
+    ruby -rrubygems test/facebook_party_test.rb
+
+== Simple Auth
+
+By far the easiest way I've found to do simple server-side auth
+is to use the <tt>auth_url</tt> method of FacebookParty.
+Send the user to the returned url. Once authenticated and authorized,
+the user will be redirected to the specified <tt>next_url</tt>, and
+details including the <tt>session_key</tt> will be included in the
+url parameters.
+
+== License
+
+The MIT License
+
+Copyright (c) 2010 Tim Morgan
+
+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/lib/facebook_party.rb

@@ -0,0 +1,74 @@
+require 'httparty'
+require 'md5'
+require 'uri'
+
+class FacebookParty
+
+  ENDPOINT = 'http://api.facebook.com/restserver.php'
+  API_VERSION = '1.0'
+  LOGIN_URL = 'http://www.facebook.com/login.php'
+  LOGIN_SUCCESS_URL = 'http://www.facebook.com/connect/login_success.html'
+  LOGIN_CANCEL_URL = 'http://www.facebook.com/connect/login_failure.html'
+
+  include HTTParty
+  format :xml
+  
+  attr_accessor :token
+
+  # Create a new FacebookParty instance.
+  # Pass in the api key and api secret for your app assigned by Facebook.
+  # The <tt>method</tt> argument is used internally -- don't pass anything into this argument.
+  def initialize(api_key, secret, method=nil)
+    @api_key = api_key
+    @secret = secret
+    @method = method
+  end
+  
+  # Call any api method directly on the instance, e.g.:
+  #     fb = FacebookParty.new(API_KEY, SECRET)
+  #     response = fb.auth.createToken
+  def method_missing(method_name, args={}, test=nil)
+    if @method
+      args = self.class.stringify_hash_keys(args)
+      args.merge!('method' => @method + '.' + method_name.to_s, 'api_key' => @api_key, 'v' => API_VERSION)
+      args.merge!('sig' => generate_sig(args))
+      self.class.post(ENDPOINT, :body => args)
+    else
+      self.class.new(@api_key, @secret, method_name.to_s)
+    end
+  end
+  
+  # Build an authentication/authorization url for Facebook Connect apps
+  # (typically used for Desktop apps)
+  # See http://wiki.developers.facebook.com/index.php/Authorization_and_Authentication_for_Desktop_Applications
+  # <tt>req_params</tt> one or more options from list http://wiki.developers.facebook.com/index.php/Extended_permissions
+  def auth_url(options={})
+    options = {
+      'api_key'          => @api_key,
+      'fbconnect'        => true,
+      'v'                => API_VERSION,
+      'connect_display'  => 'page',
+      'return_session'   => true,
+      'session_key_only' => true,
+      'next'             => LOGIN_SUCCESS_URL,
+      'cancel_url'       => LOGIN_CANCEL_URL,
+      'req_perms'        => ['read_stream', 'publish_stream', 'offline_access'],
+    }.merge(self.class.stringify_hash_keys(options))
+    options['req_perms'] = options['req_perms'].join(',')
+    args = options.map { |k, v| "#{k}=#{URI.escape(v.to_s)}" }.join('&')
+    "#{LOGIN_URL}?#{args}"
+  end
+  
+  # Generate the MD5 signature from passed in hash of arguments
+  def generate_sig(args)
+    MD5.hexdigest(args.sort.map { |k, v| "#{k}=#{v}" }.join + @secret)
+  end
+  
+  def self.stringify_hash_keys(hash) #:nodoc:
+    hash.inject({}) do |options, (key, value)|
+      options[key.to_s] = value
+      options
+    end
+  end
+  
+end

data/test/facebook_party_test.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/../lib/facebook_party'
+require 'test/unit'
+require 'md5'
+
+class FacebookPartyTest < Test::Unit::TestCase
+
+  def setup
+    if ENV['FACEBOOK_API_KEY'] and ENV['FACEBOOK_API_SECRET']
+      @fb = FacebookParty.new(ENV['FACEBOOK_API_KEY'], ENV['FACEBOOK_API_SECRET'])
+    else
+      puts 'Must set FACEBOOK_API_KEY and FACEBOOK_API_SECRET env variables before running.'
+      exit(1)
+    end
+  end
+
+  def test_sig
+    assert_equal MD5.hexdigest("arg1=val1arg2=val2#{ENV['FACEBOOK_API_SECRET']}"), @fb.generate_sig({'arg1' => 'val1', 'arg2' => 'val2'})
+  end
+  
+  def test_create_token
+    response = @fb.auth.createToken
+    assert response['auth_createToken_response']
+  end
+
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: facebook_party
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tim Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-26 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: tim@timmorgan.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- lib/facebook_party.rb
+- test/facebook_party_test.rb
+has_rdoc: true
+homepage: http://github.com/seven1m/facebook_party
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Lightweight wrapper for Facebook API using HTTParty
+test_files: []
+