faceb 0.1.0 → 0.1.1

data/CHANGELOG

@@ -0,0 +1,8 @@
+- 0.1.1 (April 6st, 2010)
+  - Added some Rails 2.3.x compatibility 
+  - Allow to reset the current session via 'reset!' instance method
+  - Renamed 'FaceB#current_session' in 'FaceB#session'
+  - Allow FaceB::Session to call Facebook API method dynamically.
+  eg :
+    session.users.getInfo :fields => 'name', :uids => 12345
+    => session.call('users.getInfo', :fields => 'name', :uids => 12345)

data/README.md

@@ -20,28 +20,46 @@ Or if you call more than once API methods, you can create a persistent session l
 
     require 'faceb'
     FaceB.new('api-key', 'secret-key')
-    FaceB.current_session.call('method.name1', :param1 => 'value1')
-    FaceB.current_session.call('method.name2', :param1 => 'value1')
+    FaceB.session.call('users.getInfo', :fields => 'name', :uids => 123456)
+    FaceB.session.call('users.getInfo', :fields => 'name', :uids => 123456)
+
+Or you can even call API method dynamically :
+
+    require 'faceb'
+    FaceB.new('api-key', 'secret-key')
+    FaceB.session.users.getInfo(:fields => 'name', :uids => 123456)
+
 
 ### Rails integration
 
-For now FaceB works only with Rails 3. A version compatible with Rails 2.3.x is in progress.
+#### Rails 3 initialization
 
-First thing to do is to add FaceB as dependency of your new project, add this line to your `Gemfile` : 
+First thing to do is to add FaceB as dependency of your new project, add this line at the end of your `Gemfile` file : 
 
     gem 'faceb'
 
 Then call the initialization script like this :
 
-    $ ./script/rails generate face_b:config
+    $ ./script/rails generate face_b:config --api-key=xxxx --secret-key=xxxx
 
 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
+#### Rails 2.3.x initialization
+
+In your `config/environment.rb` add this line : 
+
+    Rails::Initializer.run do |config|
+      [...]
+      config.gem 'faceb'
+      [...]
+    end
+
+And run the following rake task :
+
+    rake face_b:config API_KEY=xxxx SECRET_KEY=xxxx
 
-A version compatible with Rails 2.3.x is in progress.
 
 
 ## TODO

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/faceb.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{faceb}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   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.date = %q{2010-04-06}
   s.default_executable = %q{console}
   s.description = %q{Facebook library}
   s.email = %q{mathieu@tigerlilyapps.com}
@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
      ".gitignore",
+     "CHANGELOG",
      "Gemfile",
      "LICENSE",
      "README.md",

data/features/step_definitions/facebook-session_steps.rb

@@ -6,7 +6,7 @@ Given /^I have facebook instance configured$/ do
 end
 
 When /^I ask for the current Facebook session$/ do
-  FaceB.current_session
+  FaceB.session
 end
 
 Then /^I should retrieve the current Facebook session$/ do

data/lib/faceb/base.rb

@@ -4,7 +4,7 @@ module FaceB
     # Return the current Facebook session
     # 
     # @return [FaceB::Session] The current facebook session
-    def current_session
+    def session
       Session.current
     end
     

data/lib/faceb/rails.rb

@@ -1,12 +1,13 @@
+require 'faceb/rails/base'
+
 if Rails.version >= "3.0"
   require 'faceb/rails/railtie'
   require 'faceb/rails/generators'
+  require 'faceb/rails/api'
 elsif Rails.version >= "2.3"
   require 'faceb/rails/rails_23_init'
 else
   raise "Sorry, but FaceB needs Rails 2.3 or later"
 end
 
-require 'faceb/rails/base'
-require 'faceb/rails/api'
 require 'faceb/rails/controller'

data/lib/faceb/rails/generators/config/templates/faceb.yml

@@ -1,6 +1,11 @@
 development: &DEVELOPMENT
-  api_key: <%= options.api_key %>
-  secret_key: <%= options.secret_key %>
+  api_key: <%= ENV['API_KEY'] || options.api_key %>
+  secret_key: <%= ENV['SECRET_KEY'] || options.secret_key %>
+  tunnel:
+    public_host: 
+    public_host_username: 
+    public_port: 
+    local_port: 
     
 test: 
-  <<: *DEVELOPMENT
+  <<: *DEVELOPMENT

data/lib/faceb/rails/tasks/faceb.tasks

@@ -1,6 +1,13 @@
-namespace :faceb do
+require 'erb'
+
+namespace :face_b do
   desc "Configure environment to use FaceB"
   task :config => :environment do
-    # Todo config task for Rails 2.3.x
+    ENV['API_KEY'] ||= ""
+    ENV['SECRET_KEY'] ||= ""
+    config_file = File.dirname(__FILE__) + '/../generators/config/templates/faceb.yml'
+    File.open(File.join(Rails.root, 'config', 'faceb.yml'), 'w') do |f|
+      f.write ERB.new(IO.read(config_file)).result(binding)
+    end
   end
 end

data/lib/faceb/rails/tasks/tunnel.tasks

@@ -1,4 +1,4 @@
-namespace :faceb do
+namespace :face_b do
   
   tunnel_ns = namespace :tunnel do 
     # Courtesy of Christopher Haupt

data/lib/faceb/session.rb

@@ -15,6 +15,10 @@ module FaceB
       @current_session = nil
     end
     
+    def reset!
+      self.class.reset!
+    end
+    
     def initialize(api_key, secret_key, session_key = nil)
       @api_key            = api_key
       @secret_key         = secret_key
@@ -23,6 +27,7 @@ module FaceB
     end
     
     def call(method, params ={})
+      @scope = nil
       Api.new(self).call(method, params)
     end
     
@@ -34,5 +39,15 @@ module FaceB
     def secured?
       !!@user_facebook_uid
     end
+    
+    # Allow session to dynamically call API method
+    def method_missing(method_name, args={})
+      if !!@scope
+        self.call("#{@scope}.#{method_name}", args)
+      else
+        @scope = method_name
+        self
+      end
+    end
   end
 end

data/spec/faceb_base_spec.rb

@@ -2,12 +2,12 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe FaceB do
   
-  describe "#current_session" do
+  describe "#session" do
     before(:each) do
       @session = FaceB.new('api-key', 'secret-key')
     end
     
-    subject { FaceB.current_session }
+    subject { FaceB.session }
     
     it { should be_an_instance_of(FaceB::Session) }
     it { should == @session }
@@ -29,7 +29,7 @@ describe FaceB do
     
     it "should be able to reset the current session" do
       FaceB::Session.reset!
-      FaceB.current_session.should be_nil
+      FaceB.session.should be_nil
     end
   end
   
@@ -38,7 +38,7 @@ describe FaceB do
     it "should be able to call the api without create a session before" do
       mock.instance_of(FaceB::Session).call('method', :params => 1) { "response" }
       FaceB.call('api-key', 'secret-key', 'method', :params => 1).should == "response"
-      FaceB.current_session.should be_nil
+      FaceB.session.should be_nil
     end
   end
   

data/spec/faceb_session_spec.rb

@@ -3,6 +3,25 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 module FaceB
   describe Session do
     
+    # Dynamic API call
+    context "When call API" do
+      before(:each) do
+        @session = FaceB::Session.new('api-key', 'secret-key')
+      end
+      
+      it "should be able to call an API method" do
+        mock(FaceB::Api).post(FaceB::Api::API_SERVER_URL, is_a(Hash)) { "data" }
+        response = @session.call('scope.api_method', :param1 => 'value1')
+        response.should be_an_instance_of(FaceB::Api::Response)
+        response.data.should == "data"
+      end
+      
+      it "should be able to dynamically build an API method" do
+        mock(@session).call('scope.api_method', :param1 => 'value1')
+        response = @session.scope.api_method(:param1 => 'value1')
+      end
+    end
+    
     # Create session
     context "When create session" do
       before(:each) do
@@ -20,10 +39,15 @@ module FaceB
         FaceB::Session.current.should == @session
       end
       
-      it "should be able to reset the current session" do
+      it "should be able to reset the current session by class method" do
         FaceB::Session.reset!
         FaceB::Session.current.should be_nil
       end
+      
+      it "should be able to reset the current session by instance method" do
+        FaceB::Session.current.reset!
+        FaceB::Session.current.should be_nil
+      end
     end
     
     # New session

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Mathieu Fosse
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-05 00:00:00 +02:00
+date: 2010-04-06 00:00:00 +02:00
 default_executable: console
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -111,6 +111,7 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
+- CHANGELOG
 - Gemfile
 - LICENSE
 - README.md