faceb 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,24 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.yardoc
+doc
+spec/tmp

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://gemcutter.org"
+
+# Need to install Rails from source
+gem "rails", :git => "git://github.com/rails/rails.git"
+gem "httparty", "0.5.2"
+gem "rack-facebook", "0.0.3"
+
+group :test do
+  gem "rspec", ">= 1.2.9"
+  gem "cucumber", ">= 0"
+  gem "fakeweb", ">= 1.2.8"
+  gem "rr", ">= 0.10.10"
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mathieu Fosse
+
+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,70 @@
+# FaceB
+
+FaceB is a Facebook Library which aims to be more modular than Facebooker. You can use it only for the Facebook API client or if you use Rails you can have a lot of stuff helping you to develop your Facebook application (controller, helper methods).
+
+## Installation
+
+    $ [sudo] gem install faceb
+
+## Getting started
+
+### Facebook API client
+
+FaceB is modular so you can use it just as a tool for interact with Facebook API.
+You are free to use this syntax :
+
+    require 'faceb'
+    FaceB.call('api-key', 'secret-key', 'method.name', :param1 => 'value1')
+
+Or if you call more than once API methods, you can create a persistent session like that :
+
+    require 'faceb'
+    FaceB.new('api-key', 'secret-key')
+    FaceB.current_session.call('method.name1', :param1 => 'value1')
+    FaceB.current_session.call('method.name2', :param1 => 'value1')
+
+### Rails integration
+
+For now FaceB works only with Rails 3. A version compatible with Rails 2.3.x is in progress.
+
+First thing to do is to add FaceB as dependency of your new project, add this line to your `Gemfile` : 
+
+    gem 'faceb'
+
+Then call the initialization script like this :
+
+    $ ./script/rails generate face_b:config
+
+This generator will create a new file named `faceb.yml` in your `config` directory.
+Edit this new file with your Facebook application properties.
+
+
+## Rails 2.3.x
+
+A version compatible with Rails 2.3.x is in progress.
+
+
+## TODO
+
+- Add mutli Facebook application settings (alternative api key)
+- Add view helpers
+- Add Facebook connect helpers
+- Add Rails 2.3.x compatibility
+
+## Contributors
+
+- Mathieu Fosse
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Mathieu Fosse. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,76 @@
+require 'rubygems'
+require 'rake'
+require 'yard'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "faceb"
+    gem.summary = %Q{Facebook library}
+    gem.description = %Q{Facebook library}
+    gem.email = "mathieu@tigerlilyapps.com"
+    gem.homepage = "http://github.com/tigerlily/faceb"
+    gem.authors = ["Mathieu Fosse"]
+    gem.add_dependency "httparty", ">= 0.5.2"
+    gem.add_dependency "rack-facebook", ">= 0.0.3"
+    
+    # Tests
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "cucumber", ">= 0"
+    gem.add_development_dependency "fakeweb", ">= 1.2.8"
+    gem.add_development_dependency "rr", ">= 0.10.10"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:spec_rails) do |spec|
+  ruby_path = `which ruby`.chomp
+  spec.ruby_cmd = "FACEB_TEST=rails #{ruby_path}"
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/rails/*_spec.rb']
+end
+
+desc 'Run all FaceB tests.'
+task :spec_all => [:spec, :spec_rails]
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+
+  task :features => :check_dependencies
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "FaceB #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# Yard
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/console

@@ -0,0 +1,3 @@
+#!/opt/local/bin/ruby
+require 'rubygems'
+require 'irb'

data/faceb.gemspec

@@ -0,0 +1,164 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{faceb}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mathieu Fosse"]
+  s.date = %q{2010-04-05}
+  s.default_executable = %q{console}
+  s.description = %q{Facebook library}
+  s.email = %q{mathieu@tigerlilyapps.com}
+  s.executables = ["console"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "Gemfile",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "bin/console",
+     "faceb.gemspec",
+     "features/faceb-session.feature",
+     "features/step_definitions/facebook-session_steps.rb",
+     "features/support/env.rb",
+     "lib/faceb.rb",
+     "lib/faceb/api.rb",
+     "lib/faceb/base.rb",
+     "lib/faceb/rails.rb",
+     "lib/faceb/rails/api.rb",
+     "lib/faceb/rails/base.rb",
+     "lib/faceb/rails/configuration.rb",
+     "lib/faceb/rails/controller.rb",
+     "lib/faceb/rails/generators.rb",
+     "lib/faceb/rails/generators/config/USAGE",
+     "lib/faceb/rails/generators/config/config_generator.rb",
+     "lib/faceb/rails/generators/config/templates/faceb.yml",
+     "lib/faceb/rails/generators/fb_connect/USAGE",
+     "lib/faceb/rails/generators/fb_connect/fb_connect_generator.rb",
+     "lib/faceb/rails/generators/fb_connect/templates/xd_receiver.html",
+     "lib/faceb/rails/generators/fb_connect/templates/xd_receiver_ssl.html",
+     "lib/faceb/rails/rails_23_init.rb",
+     "lib/faceb/rails/railtie.rb",
+     "lib/faceb/rails/tasks.rb",
+     "lib/faceb/rails/tasks/faceb.tasks",
+     "lib/faceb/rails/tasks/tunnel.tasks",
+     "lib/faceb/session.rb",
+     "spec/faceb_api_spec.rb",
+     "spec/faceb_base_spec.rb",
+     "spec/faceb_session_spec.rb",
+     "spec/rails/config_generator_spec.rb",
+     "spec/rails/configuration_sepc.rb",
+     "spec/rails/controller_spec.rb",
+     "spec/rails/fb_connect_generator_spec.rb",
+     "spec/rails/railtie_spec.rb",
+     "spec/rails_app/app/controllers/application_controller.rb",
+     "spec/rails_app/app/controllers/posts_controller.rb",
+     "spec/rails_app/app/helpers/application_helper.rb",
+     "spec/rails_app/config.ru",
+     "spec/rails_app/config/application.rb",
+     "spec/rails_app/config/boot.rb",
+     "spec/rails_app/config/database.yml",
+     "spec/rails_app/config/environment.rb",
+     "spec/rails_app/config/environments/development.rb",
+     "spec/rails_app/config/environments/production.rb",
+     "spec/rails_app/config/environments/test.rb",
+     "spec/rails_app/config/faceb.yml",
+     "spec/rails_app/config/initializers/backtrace_silencers.rb",
+     "spec/rails_app/config/initializers/cookie_verification_secret.rb",
+     "spec/rails_app/config/initializers/inflections.rb",
+     "spec/rails_app/config/initializers/mime_types.rb",
+     "spec/rails_app/config/initializers/session_store.rb",
+     "spec/rails_app/config/locales/en.yml",
+     "spec/rails_app/config/routes.rb",
+     "spec/rails_app/log/development.log",
+     "spec/rails_app/log/production.log",
+     "spec/rails_app/log/server.log",
+     "spec/rails_app/log/test.log",
+     "spec/rails_app/public/404.html",
+     "spec/rails_app/public/422.html",
+     "spec/rails_app/public/500.html",
+     "spec/rails_app/public/favicon.ico",
+     "spec/rails_app/public/javascripts/application.js",
+     "spec/rails_app/public/javascripts/controls.js",
+     "spec/rails_app/public/javascripts/dragdrop.js",
+     "spec/rails_app/public/javascripts/effects.js",
+     "spec/rails_app/public/javascripts/prototype.js",
+     "spec/rails_app/public/javascripts/rails.js",
+     "spec/rails_app/public/stylesheets/.gitkeep",
+     "spec/rails_app/script/rails",
+     "spec/rails_spec_helper.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/tigerlily/faceb}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Facebook library}
+  s.test_files = [
+    "spec/faceb_api_spec.rb",
+     "spec/faceb_base_spec.rb",
+     "spec/faceb_session_spec.rb",
+     "spec/rails/config_generator_spec.rb",
+     "spec/rails/configuration_sepc.rb",
+     "spec/rails/controller_spec.rb",
+     "spec/rails/fb_connect_generator_spec.rb",
+     "spec/rails/railtie_spec.rb",
+     "spec/rails_app/app/controllers/application_controller.rb",
+     "spec/rails_app/app/controllers/posts_controller.rb",
+     "spec/rails_app/app/helpers/application_helper.rb",
+     "spec/rails_app/config/application.rb",
+     "spec/rails_app/config/boot.rb",
+     "spec/rails_app/config/environment.rb",
+     "spec/rails_app/config/environments/development.rb",
+     "spec/rails_app/config/environments/production.rb",
+     "spec/rails_app/config/environments/test.rb",
+     "spec/rails_app/config/initializers/backtrace_silencers.rb",
+     "spec/rails_app/config/initializers/cookie_verification_secret.rb",
+     "spec/rails_app/config/initializers/inflections.rb",
+     "spec/rails_app/config/initializers/mime_types.rb",
+     "spec/rails_app/config/initializers/session_store.rb",
+     "spec/rails_app/config/routes.rb",
+     "spec/rails_spec_helper.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::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0.5.2"])
+      s.add_runtime_dependency(%q<rack-facebook>, [">= 0.0.3"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
+      s.add_development_dependency(%q<fakeweb>, [">= 1.2.8"])
+      s.add_development_dependency(%q<rr>, [">= 0.10.10"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0.5.2"])
+      s.add_dependency(%q<rack-facebook>, [">= 0.0.3"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<cucumber>, [">= 0"])
+      s.add_dependency(%q<fakeweb>, [">= 1.2.8"])
+      s.add_dependency(%q<rr>, [">= 0.10.10"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0.5.2"])
+    s.add_dependency(%q<rack-facebook>, [">= 0.0.3"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<cucumber>, [">= 0"])
+    s.add_dependency(%q<fakeweb>, [">= 1.2.8"])
+    s.add_dependency(%q<rr>, [">= 0.10.10"])
+  end
+end
+

data/features/faceb-session.feature

@@ -0,0 +1,7 @@
+Feature: Facebook session managment
+  In order to use a Facebook session
+
+  Scenario: Retrieve Facebook session
+    Given I have facebook instance configured
+    When I ask for the current Facebook session
+    Then I should retrieve the current Facebook session

data/features/step_definitions/facebook-session_steps.rb

@@ -0,0 +1,14 @@
+Given /^I have facebook instance configured$/ do
+  FaceB.new({
+    :api_key => 'api-key',
+    :secret_key => 'secret-key'
+  })
+end
+
+When /^I ask for the current Facebook session$/ do
+  FaceB.current_session
+end
+
+Then /^I should retrieve the current Facebook session$/ do
+  pending # express the regexp above with the code you wish you had
+end

data/features/support/env.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'faceb'
+
+require 'spec/expectations'

data/lib/faceb.rb

@@ -0,0 +1,7 @@
+require 'faceb/base'
+require 'faceb/session'
+require 'faceb/api'
+
+# Rails
+require 'faceb/rails' if defined?(Rails)
+

data/lib/faceb/api.rb

@@ -0,0 +1,69 @@
+require 'httparty'
+require 'digest/md5'
+
+module FaceB
+  # Api
+  class Api
+    include HTTParty
+    default_params :format => 'JSON', :v => '1.0'
+    API_SERVER_URL = "http://api.facebook.com/restserver.php"
+    
+    def initialize(session)
+      @session  = session
+    end
+    
+    ##
+    # Call a Facebook API method
+    # 
+    # @param [String] method The API method to call
+    # @param [Hash] params Params to pass to API method call
+    # @option params [Boolean, String] :session_key if true use the current Facebook session key else if string use this string as session key
+    # 
+    # @return [FaceB::Api::Response] The API method response
+    def call(method, params = {})
+      params[:call_id] = Time.now.tv_sec.to_s if params.delete(:call_id)
+      params[:session_key] = @session.session_key if params[:session_key] == true && !!@session.session_key
+      
+      p = Api.default_params.merge(:method => method, :api_key => @session.api_key)
+      p.merge!(params)
+      
+      Response.new(Api.post(API_SERVER_URL, :body => generate_signature(p, @session.secret_key)))
+    end
+    
+    private
+      def generate_signature(params, secret)
+        p = params.map { |name, value| [name, value].join('=') }.sort.join
+        params.merge(:sig => Digest::MD5.hexdigest([p, secret].join))
+      end
+      
+    # Response
+    class Response
+      attr_reader :data
+      
+      def initialize(data)
+        @data = data
+        raise Error.new(data["error_code"], data["error_msg"]) if data.respond_to?(:include?) && data.include?("error_msg")
+      end
+      
+      def method_missing(name, *args)
+        if @data.is_a?(Hash)
+          @data[name.to_s]
+        elsif @data.is_a?(Array) && @data.size == 1 && @data.first.is_a?(Hash)
+          @data.first[name.to_s]
+        end
+      end
+      
+      def error
+        {:code =>  @data['error_code'], :msg => @data['error_msg'] }
+      end
+    end
+    
+    # Api Error
+    class Error < StandardError
+      def initialize(error_code, error_msg)
+        super("Facebook error #{error_code} : '#{error_msg}'")
+      end
+    end
+    
+  end
+end