Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
113 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,3 @@ | ||
CHANGELOG.rdoc | ||
COPYING.rdoc | ||
History.rdoc | ||
README.rdoc | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,104 @@ | ||
= Facebooker | ||
|
||
* http://facebooker.rubyforge.org | ||
|
||
== DESCRIPTION: | ||
|
||
Facebooker is a Ruby wrapper over the Facebook[http://facebook.com] {REST API}[http://wiki.developers.facebook.com/index.php/API]. Its goals are: | ||
|
||
* Idiomatic Ruby | ||
* No dependencies outside of the Ruby standard library (This is true with Rails 2.1. Previous Rails versions require the JSON gem) | ||
* Concrete classes and methods modeling the Facebook data, so it's easy for a Rubyist to understand what's available | ||
* Well tested | ||
|
||
|
||
== FEATURES/PROBLEMS: | ||
|
||
* Idiomatic Ruby | ||
* No dependencies outside of the Ruby standard library | ||
* Concrete classes and methods modeling the Facebook data, so it's easy for a Rubyist to understand what's available | ||
* Well tested | ||
|
||
== SYNOPSIS: | ||
|
||
View David Clements' {excellent tutorial}[http://apps.facebook.com/facebooker_tutorial] at {http://apps.facebook.com/facebooker_tutorial/}[http://apps.facebook.com/facebooker_tutorial] or check out {Developing Facebook Platform Applications with Rails}[http://www.pragprog.com/titles/mmfacer]. | ||
{Join the Mailing List}:[groups.google.com/group/facebooker] | ||
|
||
== REQUIREMENTS: | ||
|
||
None | ||
|
||
== INSTALL: | ||
|
||
=== Non Rails | ||
|
||
The best way is: | ||
|
||
gem install facebooker | ||
|
||
If, for some reason, you can't/won't use RubyGems, you can do: | ||
|
||
(sudo) ruby setup.rb | ||
|
||
=== Rails | ||
|
||
Facebooker can be installed as a Rails plugin by: | ||
|
||
script/plugin install git://github.com/mmangino/facebooker.git | ||
|
||
If you don't have git, the plugin can be downloaded from http://github.com/mmangino/facebooker/tarball/master | ||
|
||
Once the plugin is installed, you will need to configure your Facebook app in config/facebooker.yml. | ||
|
||
Your application users will need to have added the application in facebook to access all of facebooker's features. You enforce this by adding | ||
|
||
ensure_application_is_installed_by_facebook_user | ||
|
||
to your application controller. | ||
|
||
== using MemCache session | ||
|
||
Facebook uses some non alphanum characters in the session identifier which interfere with memcache stored sessions. If you want to use MemCache for storing sessions, you can override the valid session id method on memcache by placing the following code in an initializer: | ||
|
||
# add - as an okay key | ||
class CGI | ||
class Session | ||
class MemCacheStore | ||
def check_id(id) #:nodoc:# | ||
/[^0-9a-zA-Z\-\._]+/ =~ id.to_s ? false : true | ||
end | ||
end | ||
end | ||
end | ||
|
||
|
||
== LICENSE: | ||
|
||
(The MIT License) | ||
|
||
Copyright (c) 2008-2009: | ||
|
||
* Chad Fowler | ||
* Patrick Ewing | ||
* Mike Mangino | ||
* Shane Vitarana | ||
* Corey Innis | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters