graph-api 0.9.1

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    graph-api (0.9.1)
+      rake
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rake (0.9.2.2)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  graph-api!
+  rspec

data/Rakefile

@@ -0,0 +1,4 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec

data/graph_api.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'graph_api/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'graph-api'
+  gem.date          = '2012-10-03'
+  gem.version       = GraphAPI::VERSION
+  gem.authors       = ['Nick Barth']
+  gem.email         = ['nick@nickbarth.ca']
+  gem.summary       = 'A Ruby Gem for common Facebook Graph API tasks.'
+  gem.description   = 'GraphAPI is a Ruby Gem containing some common tasks to help manage Facebook users using the Facebook Graph API.'
+  gem.homepage      = 'https://github.com/nickbarth/RakeAR'
+
+  gem.add_dependency('rake')
+  gem.add_development_dependency('rspec')
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep /spec/
+  gem.require_paths = ['lib']
+end

data/lib/graph_api.rb

@@ -0,0 +1,117 @@
+require 'json'
+# Public: Various methods useful for interfacing with Facebook Graph protocol.
+#
+# Example:
+#
+#   get '/facebook_login' do
+#     redirect FaceGraph::auth_url
+#   end
+#
+#   get '/facebook_auth' do
+#     @facebook_user = GraphAPI::fetch_user(params[:code])
+#     @photo = GraphAPI::fetch_photo(@facebook_user['access_token'])
+#     render :signed_in
+#   end
+#
+module GraphAPI
+  # Public: Required constant used for Facebook private application secret.
+  #
+  # Example:
+  #
+  # APP_SECRET = '124ca2a483f12723cafa7a5da33a3492'
+
+  # Public: Required constant used for Facebook private application client ID.
+  #
+  # Example
+  #
+  # CLIENT_ID  = '234513432316919'
+
+  # Public: Reqired constant used for Facebook call back URL when receiving the Facebook connect code param.
+  #
+  # Example
+  #
+  # CALLBACK_URL = nil
+
+  # Public: Required constant used for setting Facebook application requirements.
+  #
+  # Example
+  #
+  # ACCESS_SCOPE = [:offline_access, :email, :user_photos, :user_location, :user_about_me]
+
+  # Public: Required constant used for setting the fields pulled for.
+  #
+  # Example
+  #
+  # USER_FIELDS = [:id, :picture, :name, :gender, :link, :email, :verified, :bio]
+
+  # Public: Creates and returns a Facebook Authentication URL based on the supplied constants.
+  #
+  # callback_url - With CALLBACK_URL set to nil setting this parameter will use
+  #                the sent callback. This is useful when you're using dynamic
+  #                URIs with subdomains.
+  def self.auth_url(callback_url=nil)
+    "https://graph.facebook.com/oauth/authorize?client_id=#{CLIENT_ID}" +
+    "&redirect_uri=#{CALLBACK_URL or callback_url}" +
+    "&scope=#{ACCESS_SCOPE.join(',')}"
+  end
+
+  # Public: Requests the Access Token from the Facebook Graph API and returns it as a string.
+  #
+  # code - The code parameter is the param you receive when the Facebook Graph
+  #        API hits your call back URI.
+  #
+  # callback_url - With CALLBACK_URL set to nil setting this parameter will use
+  #                the sent callback. This is useful when you're using dynamic
+  #                URIs with subdomains.
+  def self.fetch_token(code, callback_url=nil)
+    RestClient.get('https://graph.facebook.com/oauth/access_token', { client_id:     CLIENT_ID,
+                                                                      redirect_uri:  (CALLBACK_URL or callback_url),
+                                                                      client_secret: APP_SECRET,
+                                                                      code:          code
+    })[/access_token=(.+?)&/, 1]
+  end
+
+  # Creates a request to the Facebook graph API and returns the response.
+  #
+  # url - The URL of the request begining with a forward slash.
+  # access_token - The access token required for making the request on the Facebook users behalf.
+  #
+  # Returns a parsed JSON array returned from the Facebook service with a format like ['example' => 'some_data'].
+  def self.request(url, access_token)
+    JSON.parse(RestClient.get "https://graph.facebook.com#{url}&access_token=#{access_token}")
+  end
+
+  # Public: Returns a Facebook user array containing the fields set by the
+  #         USER_FIELDS constant and the access token for convenience.
+  def self.request_user(access_token)
+    request("/me?&fields=#{USER_FIELDS.join(',')}", access_token).
+      merge('access_token' => access_token)
+  end
+
+  # Public: Convenience method for fetching a Facebook user array from the
+  #         Facebook token code.
+  #
+  # callback_url - With CALLBACK_URL set to nil setting this parameter will use
+  #                the sent callback. This is useful when you're using dynamic
+  #                URIs with subdomains.
+  def self.fetch_user(code, callback_url=nil)
+    access_token = fetch_token(code, callback_url)
+    request_user(access_token)
+  end
+
+  # Public: Fetches and returns the cover photo src for a Facebook user.
+  #
+  # access_token - This method requires an Facebook Authentication token.
+  def self.fetch_photo(access_token)
+    albums = request('/me/albums?fields=id,cover_photo,type', access_token)['data']
+    photo_id = albums.find{|x| x['type'] == 'profile'}['cover_photo']
+    request("/#{photo_id}/?fields=source", access_token)['source']
+  end
+
+  # Public: Fetches and returns the current thumbnail src for a Facebook user.
+  #
+  # access_token - This method requires an Facebook Authentication token.
+  def self.fetch_thumbnail(access_token)
+    request('/me?fields=picture', access_token)['picture']
+  end
+end

data/lib/graph_api/version.rb

@@ -0,0 +1,3 @@
+module GraphAPI
+  VERSION = '0.9.1'
+end

data/readme.md

@@ -0,0 +1,44 @@
+# GraphAPI
+GraphAPI is a Ruby Gem containing some common tasks to help manage Facebook users using the Facebook Graph API.
+
+## Usage
+
+Here is how to use it.
+
+### Add it to your Gemfile
+
+    gem 'sprock-assets', require 'sprock_assets'
+
+### Set up your Facebook Appications constants
+
+You will have to configure the module before using it. Here is an example setup.
+
+    module GraphAPI
+      # Public: Required constant used for Facebook private application secret.
+      APP_SECRET = '124ca2a483f12723cafa7a5da33a3492'
+      # Public: Required constant used for Facebook private application client ID.
+      CLIENT_ID  = '234513432316919'
+      # Public: Reqired constant used for Facebook call back URL when receiving the Facebook connect code param.
+      CALLBACK_URL = nil
+      # Public: Required constant used for setting Facebook application requirements.
+      ACCESS_SCOPE = [:offline_access, :email, :user_photos, :user_location, :user_about_me]
+      # Public: Required constant used for setting the fields pulled for.
+      USER_FIELDS = [:id, :picture, :name, :gender, :link, :email, :verified, :bio]
+    end
+
+### Add it to your Application
+
+Once configured you will be able to use any of its functions in your application. Here is basic example using Sinatra.
+
+    get '/facebook_login' do
+      redirect FaceGraph::auth_url
+    end
+
+    get '/facebook_auth' do
+      @facebook_user = GraphAPI::fetch_user(params[:code])
+      @photo = GraphAPI::fetch_photo(@facebook_user['access_token'])
+      render :signed_in
+    end
+
+### License
+WTFPL © 2012 Nick Barth

data/spec/graph_api_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe GraphAPI do
+  before(:each) do
+    stub_const('RestClient', Class.new)
+    stub_const('GraphAPI::CLIENT_ID', 'CLIENT_ID')
+    stub_const('GraphAPI::APP_SECRET', 'APP_SECRET')
+  end
+
+  describe '#auth_url' do
+    before(:each) do
+      stub_const('GraphAPI::ACCESS_SCOPE', [:SCOPE1, :SCOPE2])
+    end
+
+    it 'should use generate a URI' do
+      stub_const('GraphAPI::CALLBACK_URL', nil)
+      GraphAPI.auth_url('CALLBACK').should == 'https://graph.facebook.com/oauth/authorize?client_id=CLIENT_ID&redirect_uri=CALLBACK&scope=SCOPE1,SCOPE2'
+    end
+
+    it 'should use CLIENT_ID const if avaliable' do
+      stub_const('GraphAPI::CALLBACK_URL', 'CALLBACK_URL')
+      GraphAPI.auth_url.should == 'https://graph.facebook.com/oauth/authorize?client_id=CLIENT_ID&redirect_uri=CALLBACK_URL&scope=SCOPE1,SCOPE2'
+    end
+  end
+
+  describe '#fetch_token' do
+    it 'should return the access token' do
+      stub_const('GraphAPI::CALLBACK_URL', 'CALLBACK_URL')
+      RestClient.should_receive(:get).with('https://graph.facebook.com/oauth/access_token', { client_id:     'CLIENT_ID',
+                                                                                              redirect_uri:  'CALLBACK_URL',
+                                                                                              client_secret: 'APP_SECRET',
+                                                                                              code:          'CODE'
+      }).and_return('access_token=ACCESS_TOKEN&')
+      GraphAPI.fetch_token('CODE').should == 'ACCESS_TOKEN'
+    end
+  end
+
+  describe '#fetch_token' do
+    it 'should return a Ruby Array' do
+      RestClient.should_receive(:get).with('https://graph.facebook.com/URL/?&access_token=ACCESS_TOKEN').and_return('[]')
+      GraphAPI.request('/URL/?', 'ACCESS_TOKEN').should == []
+    end
+  end
+
+  describe '#request_user' do
+    it 'should return a user' do
+      stub_const('GraphAPI::USER_FIELDS', [:FIELD1, :FIELD2])
+      GraphAPI.should_receive(:request).with('/me?&fields=FIELD1,FIELD2', 'ACCESS_TOKEN').and_return({})
+      GraphAPI.request_user('ACCESS_TOKEN').should == {'access_token' => 'ACCESS_TOKEN'}
+    end
+  end
+
+  describe '#fetch_user' do
+    it 'should return a user' do
+      stub_const('GraphAPI::USER_FIELDS', [:FIELD1, :FIELD2])
+      stub_const('GraphAPI::CALLBACK_URL', 'CALLBACK_URL')
+      GraphAPI.stub(:fetch_token).and_return('ACCESS_TOKEN')
+      GraphAPI.should_receive(:request).with('/me?&fields=FIELD1,FIELD2', 'ACCESS_TOKEN').and_return({})
+      GraphAPI.fetch_user('CODE').should == {'access_token' => 'ACCESS_TOKEN'}
+    end
+  end
+
+  describe '#fetch_photo' do
+    it 'should return a photo URI' do
+      albums_data = {'data' => [{'type' => 'profile', 'cover_photo' => 'PHOTO_ID'}]}
+      GraphAPI.should_receive(:request).with('/me/albums?fields=id,cover_photo,type', 'ACCESS_TOKEN').and_return(albums_data)
+      GraphAPI.should_receive(:request).with('/PHOTO_ID/?fields=source', 'ACCESS_TOKEN').and_return({'source' => 'PHOTO_URI'})
+      GraphAPI.fetch_photo('ACCESS_TOKEN').should == 'PHOTO_URI'
+    end
+  end
+
+  describe '#fetch_thumbnail' do
+    it 'should return a photo URI' do
+      GraphAPI.should_receive(:request).with('/me?fields=picture', 'ACCESS_TOKEN').and_return({'picture' => 'PHOTO_URI'})
+      GraphAPI.fetch_thumbnail('ACCESS_TOKEN').should == 'PHOTO_URI'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'bundler'
+Bundler.require
+
+require 'graph_api'

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: graph-api
+version: !ruby/object:Gem::Version
+  version: 0.9.1
+  prerelease: 
+platform: ruby
+authors:
+- Nick Barth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: GraphAPI is a Ruby Gem containing some common tasks to help manage Facebook
+  users using the Facebook Graph API.
+email:
+- nick@nickbarth.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- graph_api.gemspec
+- lib/graph_api.rb
+- lib/graph_api/version.rb
+- readme.md
+- spec/graph_api_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/nickbarth/RakeAR
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A Ruby Gem for common Facebook Graph API tasks.
+test_files:
+- graph_api.gemspec
+- spec/graph_api_spec.rb
+- spec/spec_helper.rb