open_graph 0.0.2

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+
+.DS_Store

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "facebook-stub"]
+	path = facebook-stub
+	url = git://github.com/change/facebook-stub.git

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in open_graph.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/Readme.md

@@ -0,0 +1,71 @@
+# OpenGraph #
+
+A ruby wrapper for the new [facebook graph api](http://developers.facebook.com/docs/reference/api/)
+
+# Ruby #
+
+## Configuration ##
+
+Gemfile
+
+    gem 'open_graph'
+
+config/facebook.yml
+
+    development:
+      appid: YOUR_APP_ID
+      key: YOUR_APP_KEY
+      secret: YOUR_APP_SECRET
+    production:
+      ...
+
+You'll have access to the config by `OpenGraph.config[:key]`
+
+## Initialization ##
+
+ApplicationController::Base has access to `fb_open_graph`
+
+`fb_open_graph` automatically parses and validates your facebook cookie like a boss.
+
+## API ##
+
+    fb_open_graph.valid?
+will return true or false if you have a valid session.
+
+    fb_open_graph.use_manual_session!(new_facebook_id, new_access_token)
+will force it to not use the cookie, but use your facebook\_id and\_access\_token instead
+
+### Get Calls ###
+
+All get calls take an options hash, but not all get calls will use them. The calls which accept paging can take (:limit, :offset, :until, and :since).
+
+    fb_open_graph.info
+will return a hash of information. possible keys may be `[:name, :email, :first_name, :middle_name, :last_name, :gender, :id, :locale :religion, :bio, :hometown, :birthday]`, etc. info[:location] returns a hash of `[:name, :city, :zip, :country, :id, :state]`
+
+    fb_open_graph.picture(:type => (square|small|large))
+will return the a hash of `{:content_type => 'image/jpeg', :image => actual_image_data}`.
+
+#### Other Get calls ####
+    friends, news_feed, profile_feed, likes, movies, music, books, notes, photo_tags, photo_albums, video_tags, video_uploads, events, groups, checkins
+
+### Publish Calls ###
+**UNDER CONSTRUCTION FOR BETTER PUBLIC API**
+
+All methods take options specified in the facebook api such as [Post](http://developers.facebook.com/docs/reference/api/post/#publishing)
+
+    publish!, note!, link!, event!, album!, checkin!
+
+### Permissions ###
+
+    fb_open_graph.has_permissions?(*permission_names_comma_separated)
+will return true or false
+
+# JavaScript #
+
+You'll want something that looks like this in your view:
+
+    if Rails.env.test?
+      include_facebook_stub
+    else
+      javascript_include_tag '//connect.facebook.net/en_US/all.js#xfbml=1'
+    end

data/lib/open_graph.rb

@@ -0,0 +1,38 @@
+require 'uri'
+require "digest/md5"
+require 'open_graph/rails/action_controller_accessor'
+require 'open_graph/rails/action_view_help'
+require 'open_graph/fb_open_graph'
+
+if defined?(RAILS_ENV) && RAILS_ENV == 'test'
+  require 'open_graph/test/facebook_stub'
+end
+
+module OpenGraph
+  def config
+    @config ||= begin
+      config = HashWithIndifferentAccess.new
+      yaml_file = YAML.load_file("#{RAILS_ROOT}/config/facebook.yml")
+      config.merge(yaml_file[RAILS_ENV])
+    end
+  end
+
+  def logger
+    @logger ||= begin
+      if defined?(::Rails.logger)
+        ::Rails.logger
+      elsif defined?(RAILS_DEFAULT_LOGGER)
+        RAILS_DEFAULT_LOGGER
+      end
+    end
+  end
+  module_function :config, :logger
+
+end
+
+if defined?(ActionController::Base)
+  ActionController::Base.send(:include, OpenGraph::Rails::ActionControllerAccessor)
+end
+if defined?(ActionView::Base)  
+  ActionView::Base.send(:include, OpenGraph::Rails::ActionViewHelp)
+end

data/lib/open_graph/fb_open_graph.rb

@@ -0,0 +1,192 @@
+module OpenGraph
+  class FBOpenGraph < Struct.new(:all_cookies)
+
+    def facebook_cookie
+      @facebook_cookie ||= begin
+        cookie = all_cookies["fbs_#{OpenGraph.config[:appid]}"]
+        validated_cookie(cookie)
+      end
+    end
+
+    def valid?
+      access_token.present?
+    end
+
+    def use_manual_session!(uid, access_token)
+      @uid = uid
+      @access_token = access_token
+      @manual = true
+    end
+
+    def access_token
+      @access_token ||= facebook_cookie['access_token'] unless @manual
+      @access_token || ''
+    end
+
+    def uid
+      @uid ||= facebook_cookie['uid'] unless @manual
+      @uid.blank? ? nil : @uid.to_i
+    end
+
+    # creates .news_feed(options)
+    # options for pagable_method
+    # :limit, :offset, :until, :since
+    # options for picture
+    # :type => (square|small|large)
+    # begin get methods
+    GRAPH_GET_METHODS = {
+      :info           => nil,
+      :friends        => :friends,
+      :news_feed      => :home,
+      :profile_feed   => :feed,
+      :likes          => :likes,
+      :movies         => :movies,
+      :music          => :music,
+      :books          => :books,
+      :notes          => :notes,
+      :photo_tags     => :photos,
+      :photo_albums   => :albums,
+      :video_tags     => :videos,
+      :video_uploads  => :'videos/uploaded',
+      :events         => :events,
+      :groups         => :groups,
+      :checkins       => :checkins,
+      :picture        => :picture
+    }
+    defines = ""
+    GRAPH_GET_METHODS.each_pair do |method, connection_type|
+      defines << <<-METHOD
+        def #{method}(options={})
+          graph_get(options.merge(:connection_type => #{connection_type.inspect}, :requested_call => #{method.inspect}))
+        end
+      METHOD
+    end
+    eval(defines)
+
+    # end get methods
+    GRAPH_PUBLISH_METHODS = {
+      # profiles
+      :publish! => :feed,
+      :note!    => :notes,
+      :link!    => :links,
+      :event!   => :events,
+      :album!   => :albums,
+      :checkin! => :checkins,
+    }
+    GRAPH_PUBLISH_METHODS.each_pair do |method, connection_type|
+      defines << <<-METHOD
+        def #{method}(options={})
+          graph_post(options.merge(:connection_type => #{connection_type.inspect}))
+        end
+      METHOD
+    end
+    eval(defines)
+
+    def fql_query(table, field_names, new_uid = uid)
+      field_names = field_names.join(', ') if field_names.is_a?(Array)
+      query = "SELECT #{field_names} FROM #{table} WHERE uid = #{new_uid}"
+      fql_get(query)
+    end
+
+    def has_permissions?(permission_names)
+      response = fql_query('permissions', permission_names)
+      permission_hash = response.first
+      return false unless permission_hash.is_a?(Hash)
+
+      permission_names = permission_names.split(',').collect(&:strip) if permission_names.is_a?(String)
+      permission_names.each do |perm|
+        return false if permission_hash[perm] != 1
+      end
+      return true
+    end
+
+    private
+
+    def validated_cookie(cookie)
+      cookie = cookie.present? ? Rack::Utils.parse_query(cookie.gsub('"', '')) : nil
+      return {} unless cookie.present?
+      cookieness = cookie.except('sig').keys.sort.collect {|k| "#{k}=#{cookie[k]}"}.join
+      cookieness += OpenGraph.config[:secret]
+      calculated_sig = Digest::MD5.hexdigest(cookieness)
+      calculated_sig == cookie['sig'] ? cookie : {}
+    end
+
+    def fql_get(query)
+      options = {
+        :access_token => access_token,
+        :query => query,
+        :format => 'json'
+      }
+      HTTParty.get("https://api.facebook.com/method/fql.query#{query_string(options)}").parsed_response
+    end
+
+    def graph_post(options={})
+      return false unless valid?
+      options.symbolize_keys!.reverse_merge!(default_options)
+      url = build_url(options.dup)
+      HTTParty.post(url).parsed_response
+    end
+
+    def fb_cache(key, value=nil)
+      @cache ||= {}
+      if(value)
+        @cache[key] = value
+      else
+        @cache[key]
+      end
+    end
+
+    # options are :connection_type, :uid, :access_token
+    # + any facebook options
+    def graph_get(options={})
+      options.symbolize_keys!.reverse_merge!(default_options)
+      requested_call = options.delete(:requested_call)
+      url = build_url(options.dup)
+
+      return fb_cache(url) if fb_cache(url)
+
+      OpenGraph.logger.info("[OpenGraph] fetching: #{url}")
+      response = HTTParty.get(url).response
+      response_hash = parse_response(response)
+      if response.is_a?(Net::HTTPOK)
+        response_hash['location'] = fetch_codified_location(options.slice(:uid, :access_token)) if requested_call == :info
+      end
+      fb_cache(url, response_hash)
+    end
+
+    def default_options
+      {:uid => uid, :access_token => access_token}
+    end
+
+    def build_url(options)
+      url = "https://graph.facebook.com/#{options.delete(:uid)}"
+      if connection_type = options.delete(:connection_type)
+        url << "/#{connection_type}"
+      end
+      url << query_string(options)
+      url
+    end
+
+    def query_string(options)
+      options.present? ? "?#{options.collect {|k, v| "#{k}=#{CGI.escape(v)}"}.join('&')}" : ""
+    end
+
+    #Craptacular way to get location of user (deprecated FB call to old api) REPLACE AT SOME POINT!
+    def fetch_codified_location(options_for_fql)
+      OpenGraph.logger.info("[OpenGraph] DEPRICATED - fetching codified location")
+      fql_query('user', 'current_location').first['current_location']
+    end
+
+    def parse_response(response)
+      case response.content_type
+      when 'text/javascript'
+        JSON.parse(response.body)
+      when 'image/jpeg'
+        {:content_type => response.content_type, :image => response.body}
+      end
+    end
+
+  end
+  
+  
+end

data/lib/open_graph/rails/action_controller_accessor.rb

@@ -0,0 +1,9 @@
+module OpenGraph
+  module Rails
+    module ActionControllerAccessor
+      def fb_open_graph
+        @fb_open_graph ||= OpenGraph::FBOpenGraph.new(cookies)
+      end
+    end
+  end
+end

data/lib/open_graph/rails/action_view_help.rb

@@ -0,0 +1,18 @@
+module OpenGraph
+  module Rails
+    module ActionViewHelp
+      @@facebook_javascript_stub = nil
+      def include_facebook_stub
+        @@facebook_javascript_stub ||= begin
+          data = ''
+          f =File.open(File.join( File.dirname(__FILE__),"../../../", "facebook-stub/", "facebook-stub.js"))
+          f.each_line do |line|
+            data << line
+          end
+          f.close
+          javascript_tag data
+        end
+      end
+    end
+  end
+end

data/lib/open_graph/test/facebook_stub.rb

@@ -0,0 +1,97 @@
+module OpenGraph
+  class FBOpenGraph
+    @@access_token = nil
+    @@uid = nil
+
+    BASE_INFO = {
+      "name"          => "Gandalf The Grey",
+      "location"      => {
+        "name"        => "San Francisco, California",
+        "city"        => "San Francisco",
+        "zip"         => "",
+        "country"     => "United States",
+        "id"          => 114952118516947,
+        "state"       => "California"
+      },
+      "timezone"      =>  -8,
+      "gender"        => "male",
+      "id"            => "6013893",
+      "birthday"      => "01/12/1987",
+      "last_name"     => "Shafer",
+      "updated_time"  => "2011-02-10T00:40:26+0000",
+      "verified"      => true,
+      "locale"        => "en_US",
+      "religion"      => "Wikipedia",
+      "bio"           => "The greatest thing you'll ever learn is just to love and be loved in return.\r\n\r\nIf hearing the name Sharon Salinger causes you physical pain and emotional trauma then we are friends.\r\n\r\nMy life has a great cast but I can't figure out the plot.",
+      "hometown"      => { "name" => nil, "id" => "" },
+      "link"          => "http://www.facebook.com/thomas.shafer",
+      "political"     => "Liberal",
+      "email"         => "gandalf@change.org",
+      "middle_name"   => "'Growly Pants'",
+      "first_name"    => "Thomas"
+    }
+
+    # class level methods for setting the responses you would like to get
+    class << self
+      def info_override!(key, value)
+        BASE_INFO[key.to_s] = value
+      end
+
+      def invalid!
+        @@access_token = ''
+      end
+
+      def valid!
+        @@access_token = 'fb_token'
+      end
+
+      def uid=(uid)
+        @@uid = uid
+      end
+
+      def access_token=(token)
+        @@access_token = token
+      end
+    end
+
+    def uid_with_testing
+      @@uid || uid_without_testing
+    end
+    alias_method_chain :uid, :testing
+
+    def access_token_with_testing
+      @@access_token || access_token_without_testing
+    end
+    alias_method_chain :access_token, :testing
+
+    defines = ''
+    GRAPH_GET_METHODS.merge(GRAPH_PUBLISH_METHODS).keys.send('-', [:friends, :info, :picture]).each do |method|
+      defines << <<-METHOD
+      def #{method}(*args)
+        raise "#{method} not stubbed!!"
+      end
+      METHOD
+    end
+    eval(defines)
+
+    def friends(*args)
+      return false unless valid?
+      {"data"=>
+       [{"name"=>"Michael Levin-Gesundheit", "id"=>"11160"},
+        {"name"=>"Eleanor Birrell", "id"=>"21139"},
+        {"name"=>"Clotilde Dedecker", "id"=>"24021"},
+        {"name"=>"Nancy Elizabeth Townsend", "id"=>"100001899260534"},
+        {"name"=>"Allba Zackson", "id"=>"100001938274584"}]}
+    end
+
+    def info(*args)
+      return false unless valid?
+      BASE_INFO
+    end
+
+    def picture(*args)
+      @picture_data ||= {:content_type => 'image/png', :image => File.read(File.dirname(__FILE__)+'/facebook_stub/picture.png')}
+    end
+
+  end
+end

data/lib/open_graph/version.rb

@@ -0,0 +1,3 @@
+module OpenGraph
+  VERSION = "0.0.2"
+end

data/open_graph.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "open_graph/version"
+
+Gem::Specification.new do |s|
+  s.name        = "open_graph"
+  s.version     = OpenGraph::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Change.org Engineering"]
+  s.email       = ["engineering@change.org"]
+  s.homepage    = "https://github.com/change/open_graph"
+  s.summary     = %q{A ruby wrapper for the new facebook graph api}
+  s.description = %q{OpenGraph provides an easy to use wrapper for making facebook calls. It also provides javascript stubs allowing seemless testing against the javascript sdk.}
+
+  s.rubyforge_project = "open_graph"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: open_graph
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Change.org Engineering
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-23 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: OpenGraph provides an easy to use wrapper for making facebook calls. It also provides javascript stubs allowing seemless testing against the javascript sdk.
+email: 
+- engineering@change.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .gitmodules
+- Gemfile
+- Rakefile
+- Readme.md
+- lib/open_graph.rb
+- lib/open_graph/fb_open_graph.rb
+- lib/open_graph/rails/action_controller_accessor.rb
+- lib/open_graph/rails/action_view_help.rb
+- lib/open_graph/test/facebook_stub.rb
+- lib/open_graph/test/facebook_stub/picture.png
+- lib/open_graph/version.rb
+- open_graph.gemspec
+has_rdoc: true
+homepage: https://github.com/change/open_graph
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: open_graph
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: A ruby wrapper for the new facebook graph api
+test_files: []
+