rest-graph 1.8.0 → 1.9.0

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "task"]
+	path = task
+	url = git://github.com/godfat/gemgem.git

data/CHANGES

@@ -1,5 +1,36 @@
 = rest-graph changes history
 
+== rest-graph 1.9.0 -- 2011-05-26
+
+* [RestGraph] Removed deprecated rest-graph/auto_load.rb, and
+              rest-graph/autoload.rb. Please simply require 'rest-graph'
+
+* [RestGraph] Removed deprecated strict option. Facebook had fixed their bug.
+
+* [RestGraph] Removed deprecated broken_old_rest. Please use old_rest instead.
+
+* [RestGraph] Removed deprecated suppress_decode. Plz use auto_decode instead.
+
+* [RestGraph] Introduced RestGraph#attributes.
+
+* [RestGraph] RestGraph#lighten and RestGraph#lighten! now takes an extra
+              argument which let you set attributes.
+
+* [RestGraph] Now RestGraph#get/post has an option for timeout which
+              make this request use this timeout instead of the default one.
+
+* [RestGraph] URI.encode on Facebook's broken paging URL. (thanks andy)
+
+* [RestGraph] Now all old_rest based methods accept a :post option, which
+              means use POST for this API request, but still treating it
+              a GET request for rest-graph, so that caching and other
+              similar features would still work.
+
+              The reason for this option is that some FQL could be very long,
+              FQL multiquery could be even much more longer! Long URLs might
+              cause problems, thus we have provided this option to use POST
+              instead.
+
 == rest-graph 1.8.0 -- 2011-03-08
 
 *  [RestGraph] Now require 'rest-graph/autoload' is deprecated, simply use

data/CONTRIBUTORS

@@ -1,9 +1,10 @@
 Lin Jen-Shin (godfat)
+Barnabas Debreczeni (keo)
+John Fan (johnfan)
 Jaime Cham (jcham)
 Andrew Liu (eggegg)
-John Fan (johnfan)
-Barnabas Debreczeni (keo)
+Mariusz Pruszynski (snicky)
 Florent Vaucelle (florent)
 Ethan Czahor (ethanz5)
 Nicolas Fouché (nfo)
-Mariusz Pruszynski (snicky)
+andy (coopsite)

data/README

@@ -53,7 +53,7 @@ A lightweight Facebook Graph API client
 
 Or if you want development version, put this in Gemfile:
 
-    gem 'rest-graph', :git => 'git://github.com/cardinalblue/rest-graph.git
+    gem 'rest-graph', :git => 'git://github.com/cardinalblue/rest-graph.git'
 
 Or as a Rails2 plugin:
 
@@ -187,36 +187,36 @@ options for RestGraph instance are also valid options for rest_graph_setup.
 
 1. Set upon RestGraph object creation:
 
-    rg = RestGraph.new :app_id => 1234
+        rg = RestGraph.new :app_id => 1234
 
 2. Set via the rest_graph_setup call in a Controller:
 
-    rest_graph_setup :app_id => 1234
+        rest_graph_setup :app_id => 1234
 
 3. Load from a YAML file
 
-    require 'rest-graph/config_util'
-    RestGraph.load_config('path/to/rest-graph.yaml', 'production')
-    rg = RestGraph.new
+        require 'rest-graph/config_util'
+        RestGraph.load_config('path/to/rest-graph.yaml', 'production')
+        rg = RestGraph.new
 
 4. Load config automatically
 
-    require 'rest-graph'  # under Rails, would load config/rest-graph.yaml
-    rg = RestGraph.new
+        require 'rest-graph'  # under Rails, would load config/rest-graph.yaml
+        rg = RestGraph.new
 
 5. Override directly
 
-    module MyDefaults
-      def default_app_id
-        '456'
-      end
+        module MyDefaults
+          def default_app_id
+            '456'
+            end
 
-      def default_secret
-        'category theory'
-      end
-    end
-    RestGraph.send(:extend, MyDefaults)
-    rg = RestGraph.new
+          def default_secret
+            'category theory'
+          end
+        end
+        RestGraph.send(:extend, MyDefaults)
+        rg = RestGraph.new
 
 ## API REFERENCE:
 
@@ -230,16 +230,20 @@ options for RestGraph instance are also valid options for rest_graph_setup.
     rg.get('me', :metadata => '1')
 
     # extra options:
-    #   auto_decode: Bool # decode with json or not in this method call
+    #   auto_decode: Bool # decode with json or not in this API request
     #                     # default: auto_decode in rest-graph instance
+    #       timeout: Int  # the timeout for this API request
+    #                     # default: timeout in rest-graph instance
     #        secret: Bool # use secret_acccess_token or not
     #                     # default: false
     #         cache: Bool # use cache or not; if it's false, update cache, too
     #                     # default: true
     #    expires_in: Int  # control when would the cache be expired
-    #                     # default: nothing
+    #                     # default: nil
     #         async: Bool # use eventmachine for http client or not
     #                     # default: false, but true in aget family
+    #       headers: Hash # additional hash you want to pass
+    #                     # default: {}
     rg.get('me', {:metadata => '1'}, :secret => true, expires_in => 600)
 
 #### post

data/README.md

@@ -53,7 +53,7 @@ A lightweight Facebook Graph API client
 
 Or if you want development version, put this in Gemfile:
 
-    gem 'rest-graph', :git => 'git://github.com/cardinalblue/rest-graph.git
+    gem 'rest-graph', :git => 'git://github.com/cardinalblue/rest-graph.git'
 
 Or as a Rails2 plugin:
 
@@ -187,36 +187,36 @@ options for RestGraph instance are also valid options for rest_graph_setup.
 
 1. Set upon RestGraph object creation:
 
-    rg = RestGraph.new :app_id => 1234
+        rg = RestGraph.new :app_id => 1234
 
 2. Set via the rest_graph_setup call in a Controller:
 
-    rest_graph_setup :app_id => 1234
+        rest_graph_setup :app_id => 1234
 
 3. Load from a YAML file
 
-    require 'rest-graph/config_util'
-    RestGraph.load_config('path/to/rest-graph.yaml', 'production')
-    rg = RestGraph.new
+        require 'rest-graph/config_util'
+        RestGraph.load_config('path/to/rest-graph.yaml', 'production')
+        rg = RestGraph.new
 
 4. Load config automatically
 
-    require 'rest-graph'  # under Rails, would load config/rest-graph.yaml
-    rg = RestGraph.new
+        require 'rest-graph'  # under Rails, would load config/rest-graph.yaml
+        rg = RestGraph.new
 
 5. Override directly
 
-    module MyDefaults
-      def default_app_id
-        '456'
-      end
+        module MyDefaults
+          def default_app_id
+            '456'
+            end
 
-      def default_secret
-        'category theory'
-      end
-    end
-    RestGraph.send(:extend, MyDefaults)
-    rg = RestGraph.new
+          def default_secret
+            'category theory'
+          end
+        end
+        RestGraph.send(:extend, MyDefaults)
+        rg = RestGraph.new
 
 ## API REFERENCE:
 
@@ -230,16 +230,20 @@ options for RestGraph instance are also valid options for rest_graph_setup.
     rg.get('me', :metadata => '1')
 
     # extra options:
-    #   auto_decode: Bool # decode with json or not in this method call
+    #   auto_decode: Bool # decode with json or not in this API request
     #                     # default: auto_decode in rest-graph instance
+    #       timeout: Int  # the timeout for this API request
+    #                     # default: timeout in rest-graph instance
     #        secret: Bool # use secret_acccess_token or not
     #                     # default: false
     #         cache: Bool # use cache or not; if it's false, update cache, too
     #                     # default: true
     #    expires_in: Int  # control when would the cache be expired
-    #                     # default: nothing
+    #                     # default: nil
     #         async: Bool # use eventmachine for http client or not
     #                     # default: false, but true in aget family
+    #       headers: Hash # additional hash you want to pass
+    #                     # default: {}
     rg.get('me', {:metadata => '1'}, :secret => true, expires_in => 600)
 
 #### post

data/TODO

@@ -8,4 +8,3 @@
 * error_handler can't be turned off
 * more docs?
 * more examples?
-* em is missing headers options

data/doc/heroku-facebook.md

@@ -0,0 +1,186 @@
+# Setting a Facebook app on Heroku
+
+## Software Installation and Configuration (1)
+
+### Mac OS
+
+* Install Xcode from the install DVD or Apple website or Mac App Store.
+
+* Install Homebrew (package manager).
+
+      curl https://gist.github.com/raw/323731/install_homebrew.rb > /tmp/install_homebrew.rb
+      ruby /tmp/install_homebrew.rb
+
+* Install Git (source code manager).
+
+      brew install git
+
+* Install database. You may pick anything that Rails supports, but since
+  Heroku uses PostgreSQL, we recommend to use the same database.
+
+      brew install postgresql
+      initdb /usr/local/var/postgres
+      pg_ctl -D /usr/local/var/postgres start
+      createuser --createdb YourProject
+
+* Setup postgres to auto-start after boot.
+
+      cp `brew --prefix postgresql`/org.postgresql.postgres.plist ~/Library/LaunchAgents/
+      launchctl load -w ~/Library/LaunchAgents/org.postgresql.postgres.plist
+
+* ...or start up postgres manually:
+
+      pg_ctl -D /usr/local/var/postgres start
+
+* Install Ruby 1.9.2 (via Homebrew, but if you prefer RVM, it's fine).
+
+      brew install ruby
+
+### Ubuntu (Linux)
+
+* Install various tools
+
+      sudo apt-get update
+      sudo apt-get install gcc g++ make libssl-dev zlib1g-dev libreadline5-dev libyaml-dev libxml2-dev
+
+* Install Git (source code manger).
+
+      sudo apt-get install git
+
+* Install database. You may pick anything Rails supports, but since
+  Heroku uses PostgreSQL, we recommend to use the same database.
+
+      sudo apt-get install postgresql libpq-dev
+      sudo /etc/init.d/postgresql restart
+      sudo -u postgres createuser --createdb YourProject
+
+  You might need to edit `pg_hba.conf` (the path would be something like this:
+  /etc/postgresql/8.4/main/pg_hba.conf) to make sure _YourProject_ has the
+  access to your local database. For example, has the following line:
+
+      local        all        YourProject        trust
+
+  And make sure there's **NO** this line: (it conflicts with the above)
+
+      local        all        all                ident
+
+  You should restart postgresql after updating `pg_hba.conf`
+
+      sudo /etc/init.d/postgresql restart
+
+* Install Ruby 1.9.2
+
+      bash < <( curl http://rvm.beginrescueend.com/releases/rvm-install-head )
+      echo '[[ -s "$HOME/.rvm/scripts/rvm" ]] && . "$HOME/.rvm/scripts/rvm"' >> ~/.bash_profile
+      source $HOME/.rvm/scripts/rvm
+      rvm install 1.9.2
+      rvm use 1.9.2
+
+### Windows (not tested)
+
+* Install Git <http://code.google.com/p/msysgit/downloads/list>
+* Install Ruby 1.9.2 <http://rubyinstaller.org/downloads/>
+* Install PostgreSQL <http://www.postgresql.org/download/>
+
+## Software Installation and Configuration (2)
+
+### General (OS-independent)
+
+* Depending on the OS and your configuration, you may need to prefix with
+  "sudo" to install the gems. You don't have to if you're following the
+  instructions above to install Ruby (RVM or Homebrew), or running on Windows.
+
+* Configure Git (~/.gitconfig)
+
+      git config --global user.name  'Your Name'
+      git config --global user.email 'your@email.com'
+
+* Install gems
+
+      echo 'gem: --no-ri --no-rdoc' >> ~/.gemrc
+      gem install rails pg heroku
+
+  Note: on newer Macs, if pg fails to install, try this:
+
+      env ARCHFLAGS='-arch x86_64' gem install pg
+
+* Generate RSA keys and upload to Heroku. (you'll need a [Heroku][] account)
+
+      ssh-keygen -t rsa -C 'your@email.com'
+      heroku keys:add ~/.ssh/id_rsa.pub
+
+[Heroku]: http://heroku.com
+
+## Create a Rails application and push to Heroku
+
+* Rails 3 project
+
+      rails new 'YourProject'
+      cd 'YourProject'
+
+* Git initialization
+
+      git init
+      git add .
+      git commit -m 'first commit'
+
+* Switch to PostgreSQL. Edit the Gemfile and change `gem 'sqlite3'` to `gem 'pg'`:
+
+      bundle check
+      git add Gemfile Gemfile.lock
+      git commit -m 'switch to postgresql'
+
+* Set up the Heroku application
+
+      heroku create 'YourProject'
+
+* Push to Heroku. (from local master branch to remote master branch)
+
+      git push heroku master:master
+
+* Take a look at yourproject.heroku.com. If you have terminal browser lynx
+  installed, you can run this:
+
+      lynx yourproject.heroku.com
+
+  Otherwise, just use your favorite browser to view it.
+
+## For development, set up the application to run locally on your computer
+
+* Edit `config/database.yml` with following:
+
+      development:
+        adapter: postgresql
+        username: YourProject
+        database: YourProject_development
+
+      test:
+        adapter: postgresql
+        username: YourProject
+        database: YourProject_test
+
+* Setup local database
+
+      rake db:create
+      rake db:migrate
+      rake db:schema:dump  # update schema.rb for reference
+      rake db:test:prepare # sometimes this is needed to run tests
+
+* Run Ruby server (WEBrick)
+
+      rails server
+
+* or run Thin server (need to update Gemfile with `gem 'thin'`)
+
+      gem install thin
+      rails server thin
+
+## Create a Facebook Application
+
+* <http://devcenter.heroku.com/articles/facebook>
+
+## Using rest-graph
+
+### Tutorial
+
+* <https://github.com/cardinalblue/samplergthree>

data/doc/tutorial.md

@@ -28,6 +28,10 @@ The code in this tutorial could be found on [samplergthree][]
         gem 'rest-client', '>=1.6'
         gem 'json'        # you may also use other JSON parsers/generators, i.e. 'yajl-ruby' or 'json_pure'
 
+   And run:
+
+        bundle install
+
 
 5. In order to configure your Rails application for the Facebook application you created, you must create a rest-graph.yaml file in your /config directory and fill it with your Facebook configuration. If you plan to run your application in the Facebook canvas, also provide a canvas name.
 

data/example/rails3/Gemfile

@@ -1,7 +1,7 @@
 
 source 'http://rubygems.org'
 
-gem 'rails', '3.0.5'
+gem 'rails', '3.0.7'
 
 gem 'rest-client' # for rest-graph
 gem 'yajl-ruby'   # for rest-graph

data/example/sinatra/config.ru

@@ -0,0 +1,16 @@
+
+require 'sinatra'
+require 'rest-graph'
+
+app_id = '123'
+secret = 'abc'
+config = {:app_id => app_id,
+          :secret => secret}
+
+post '/' do
+  rg = RestGraph.new(config)
+  rg.parse_signed_request!(params['signed_request'])
+  "#{rg.get('me').inspect.gsub('<', '&lt;')}\n"
+end
+
+run Sinatra::Application