RFb 0.1.1 → 0.2.0

data/README.markdown

@@ -1,11 +1,98 @@
 # RFb
 
-*RubyFacebook* - interact with Facebook REST API (json) - rails3 enabled
+**RubyFacebook** - interact with Facebook REST API (json) - rails3 enabled
+
+Share datas with Facebook via JSON with RFb! No XML to deal with, no parsers needed, reduced verbosity, increased happiness. Ruby1.9 required.
 
 
 ## Installation
 
-## Usage
+    gem install RFb
+
+
+## Bundling
+
+to bundle RFb, in your Gemfile:
+  
+    gem 'RFb', :require => 'r_fb'
+
+
+## Configuration
+
+configurations in yml file soon will come...
+
+
+### Rails 3
+
+- add RFb to your Gemfile
+- install it (bundle install)
+- create a new initializer file (say 'facebook.rb') and add some configurations:
+
+config/initializers/facebook.rb :
+
+    require 'r_fb'
+    
+    RFb.app_name = "your_app_name"
+    RFb.environment = Rails.env
+    RFb.api_key = { 
+      development: "your_facebook_api_key_here",
+      test: "",
+      production: ""
+    }
+    RFb.secret_key = { 
+      development: "your_facebook_secret_here",
+      test: "",
+      production: ""
+    }
+    RFb.debug = true # displays 
+
+
+
+and you're done!
+
+
+
+## Basic Usage
+
+See the facebook REST API ( http://wiki.developers.facebook.com/index.php/API ) so you can see what methods are available and how to call them. 
+
+
+*Example:*
+
+To get some user information:
+  
+    fields = %w(username name first_name has_added_app locale pic profile_url status timezone)
+    RFb.request({
+      method: "facebook.Users.getInfo", 
+      uids: [1218562195].to_s, 
+      fields: [fields].to_s
+    })
+  
+result:
+
+    [{"first_name":"Francesco","name":"Francesco Canessa","pic":"http:\/\/profile.ak.fbcdn.net\/v22940\/158\/98\/s1218562195_9493.jpg","status":{"message":"","time":0,"status_id":0},"timezone":1,"uid":1218562195,"has_added_app":true,"locale":"en_US","profile_url":"http:\/\/www.facebook.com\/makevoid","username":"makevoid"}]
+
+
+a shorter version:
+
+    User.new(fb_id: 1218562195)
+  
+  
+  
+# Setup sessions
+
+build better rails3 controllers-model api and document... I'll create an example project
+
+## Getting friends
+
+    RFb::User.new(fb_id: @current_user.fb_id).friends
+
+result (an array of users properties):
+
+    [{"current_location"=>{"city"=>"Buffalo", "state"=>"New York", "country"=>"United States", "zip"=>"14623"}, "first_name"=>"Ali", "name"=>"Ali Babloo", "pic"=>"http://profile.ak.fbcdn.net/v230/1615/8/s1027654249_4327.jpg", "status"=>{"message"=>"", "time"=>0, "status_id"=>0}, "timezone"=>-8, "has_added_app"=>true, "locale"=>"en_US", "profile_url"=>"http://www.facebook.com/dark14horse", "username"=>"dark14horse"}, {..........}, {...}]
 
+more docs will come when session handling API will be solid enough!
+  
+  
 
-yes.. documentation will come....
+Look at the source code and see that is pretty simple stuff, so fork it, change it, get inspired and roll your own... simply do whatever you want!

data/RFb.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{RFb}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Francesco 'makevoid' Canessa"]
-  s.date = %q{2010-02-11}
+  s.date = %q{2010-02-17}
   s.description = %q{RubyFacebook interacts with Facebook REST API via JSON. No XML to deal with, no parsers needed, reduced verbosity, increased happiness. Ruby1.9 required. Fork it, please!}
   s.email = %q{makevoid@gmail.com}
   s.extra_rdoc_files = [
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
      "lib/r_fb/exceptions.rb",
      "lib/r_fb/fql.rb",
      "lib/r_fb/methods.rb",
+     "lib/r_fb/notification.rb",
      "lib/r_fb/parser.rb",
      "lib/r_fb/session.rb",
      "lib/r_fb/user.rb"

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/r_fb.rb

@@ -3,14 +3,15 @@ require 'net/http'
 require 'json'
 
 module RFb
-  @@path = "r_fb"#File.expand_path("../r_fb", __FILE__)
-  require "#{@@path}/exceptions"
-  require "#{@@path}/configurable"
-  require "#{@@path}/fql"
-  require "#{@@path}/methods"
-  require "#{@@path}/parser"
-  require "#{@@path}/session"
-  require "#{@@path}/user"
+  PATH = "r_fb"
+  #PATH = File.expand_path("../r_fb", __FILE__)
+  require "#{PATH}/exceptions"
+  require "#{PATH}/configurable"
+  require "#{PATH}/fql"
+  require "#{PATH}/methods"
+  require "#{PATH}/parser"
+  require "#{PATH}/session"
+  require "#{PATH}/user"
   
   SERVER = "www.facebook.com"
   API_PATH = "#{SERVER}/restserver.php"

data/lib/r_fb/notification.rb

@@ -0,0 +1,14 @@
+module RFb
+  class Notification
+    
+    INVITE = "Sell your things to your friends and other facebook users. <fb:req-choice url='http://apps.facebook.com/alibazaar/' label='Add Ali Bazaar' />"
+    
+    # usage:
+    # Notification.send(to_ids: recipients_ids, notification: RFB::Notification::INVITE)
+    #
+    # to_ids: recipients_ids, notification: "fbml and html allowed"
+    def send(opts)
+      RFb.request(opts)
+    end
+  end
+end

data/lib/r_fb/session.rb

@@ -4,11 +4,14 @@ module RFb
      attr_accessor :params
      def initialize(params={})
        @params = filter_session_params(params)
-       @@session_key = params["fb_sig_session_key"]
+       @@rfb_session_key = params["fb_sig_session_key"]
      end
 
      def self.session_key
-       @@session_key
+       @@rfb_session_key
+     end
+     def self.session_key=(ses)
+       @@rfb_session_key = ses
      end
 
      def logged_in?

data/lib/r_fb/user.rb

@@ -6,6 +6,7 @@ module RFb
     
     attr_accessor :fb_id
     attr_accessor :user
+    attr_accessor :session
     FIELDS.map do |field|
       attr_accessor field
     end
@@ -16,6 +17,8 @@ module RFb
       end
       @user = attrs[:user]
       @fb_id = attrs[:fb_id]
+      @session = attrs[:session]
+      Session.session_key = @session unless @session.nil?
     end
     
     def self.first(attrs={})
@@ -32,8 +35,13 @@ module RFb
       u = User.new(attrs.merge(:user => user)).select_all
     end
   
+    # use FIELDS.join(", ") instead of uid to select other datas
     def friends
-      Fql.query("SELECT #{FIELDS.join(", ")} FROM user WHERE uid IN (SELECT uid2 FROM friend WHERE uid1=#{self.fb_id}) AND has_added_app = 1 ")
+      Fql.query("SELECT uid FROM user WHERE uid IN (SELECT uid2 FROM friend WHERE uid1=#{self.fb_id}) AND has_added_app = 1")
+    end
+
+    def friends_nonapp(limit=true)
+      Fql.query("SELECT uid FROM user WHERE uid IN (SELECT uid2 FROM friend WHERE uid1=#{self.fb_id}) AND has_added_app = 0#{"  LIMIT 30" if limit}")
     end
   
     def is_app_user?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: RFb
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Francesco 'makevoid' Canessa
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-11 00:00:00 +01:00
+date: 2010-02-17 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -33,6 +33,7 @@ files:
 - lib/r_fb/exceptions.rb
 - lib/r_fb/fql.rb
 - lib/r_fb/methods.rb
+- lib/r_fb/notification.rb
 - lib/r_fb/parser.rb
 - lib/r_fb/session.rb
 - lib/r_fb/user.rb