graph-api 0.9.7 → 0.9.8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    graph-api (0.9.5)
+    graph-api (0.9.7)
       json
       rake
       rest-client
@@ -9,6 +9,14 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
+    columnize (0.3.6)
+    debugger (1.2.0)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.1.1)
+      debugger-ruby_core_source (~> 1.1.3)
+    debugger-linecache (1.1.2)
+      debugger-ruby_core_source (>= 1.1.1)
+    debugger-ruby_core_source (1.1.3)
     diff-lcs (1.1.3)
     json (1.7.5)
     mime-types (1.19)
@@ -28,5 +36,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  debugger
   graph-api!
   rspec

data/graph_api.gemspec

@@ -8,14 +8,15 @@ Gem::Specification.new do |gem|
   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.summary       = 'A Ruby Gem for simplifying authentication using the Facebook Graph API.'
+  gem.description   = 'GraphAPI is a Ruby Gem created to simplifiy and help manage authentication using the Facebook Graph API.'
   gem.homepage      = 'https://github.com/nickbarth/GraphAPI'
 
   gem.add_dependency('rake')
   gem.add_dependency('json')
   gem.add_dependency('rest-client')
   gem.add_development_dependency('rspec')
+  gem.add_development_dependency('debugger')
 
   gem.files         = `git ls-files`.split($/)
   gem.test_files    = gem.files.grep /spec/

data/lib/graph_api.rb

@@ -2,55 +2,58 @@ require 'json'
 require 'rest_client'
 require 'graph_api/version'
 
-# Public: Various methods useful for interfacing with Facebook Graph protocol.
+# Public: GraphAPI is a Ruby Gem created to simplifiy and help manage
+#         authentication using the Facebook Graph API.
 #
 # Example:
 #
 #   get '/facebook_login' do
-#     redirect FaceGraph.auth_url
+#     redirect GraphAPI.auth_url
 #   end
 #
-#   get '/facebook_auth' do
-#     @facebook_user = GraphAPI.fetch_user(params[:code])
-#     @photo = GraphAPI.fetch_photo(@facebook_user['access_token'])
+#   get '/facebook_callback' do
+#     @facebook_user = GraphAPI.new(params[:code])
+#     session[:auth_token] = @facebook_user.auth_token
 #     render :signed_in
 #   end
 #
-module GraphAPI
-  # Public: Required setting used for Facebook private application secret.
-  #
-  # Example:
-  #
-  # @app_secret = '124ca2a483f12723cafa7a5da33a3492'
-  attr_accessor :app_secret
+class GraphAPI
+  class << self
+    # Public: Required setting used for Facebook private application secret.
+    #
+    # Example:
+    #
+    # @app_secret = '124ca2a483f12723cafa7a5da33a3492'
+    attr_accessor :app_secret
 
-  # Public: Required setting used for Facebook private application client ID.
-  #
-  # Example
-  #
-  # @client_id  = '234513432316919'
-  attr_accessor :client_id
+    # Public: Required setting used for Facebook application Id.
+    #
+    # Example
+    #
+    # @client_id  = '234513432316919'
+    attr_accessor :client_id
 
-  # Public: Reqired setting used for Facebook call back URL when receiving the Facebook connect code param.
-  #
-  # Example
-  #
-  # @callback_url = nil
-  attr_accessor :callback_url
+    # Public: Reqired setting used for Facebook call back URL when receiving the Facebook connect code param.
+    #
+    # Example
+    #
+    # @callback_url = nil
+    attr_accessor :callback_url
 
-  # Public: Required setting used for setting Facebook application requirements.
-  #
-  # Example
-  #
-  # @access_scope = [:offline_access, :email, :user_photos, :user_location, :user_about_me]
-  attr_accessor :access_scope
+    # Public: Required setting used for setting Facebook application requirements.
+    #
+    # Example
+    #
+    # @access_scope = [:offline_access, :email, :user_photos, :user_location, :user_about_me]
+    attr_accessor :access_scope
 
-  # Public: Required setting used for setting the fields pulled for.
-  #
-  # Example
-  #
-  # @user_fields = [:id, :picture, :name, :gender, :link, :email, :verified, :bio]
-  attr_accessor :user_fields
+    # Public: Required setting used for setting the fields pulled for.
+    #
+    # Example
+    #
+    # @user_fields = [:id, :picture, :name, :gender, :link, :email, :verified, :bio]
+    attr_accessor :user_fields
+  end
 
   # Public: Method for configuring the setting settings for a nicer syntax.
   #
@@ -59,7 +62,7 @@ module GraphAPI
   # GraphAPI.config app_secret: '124ca2a483f12723cafa7a5da33a3492',
   #                 client_id:  '234513432316919'
   #
-  def config(settings)
+  def self.config(settings)
     settings.each do |setting, value|
       self.send("#{setting}=", value)
     end
@@ -70,7 +73,7 @@ module GraphAPI
   # 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 auth_url(callback_url=nil)
+  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(',')}"
@@ -84,7 +87,7 @@ module GraphAPI
   # 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 fetch_token(code, callback_url=nil)
+  def self.fetch_token(code, callback_url=nil)
     RestClient.post('https://graph.facebook.com/oauth/access_token', { client_id:     @client_id,
                                                                        redirect_uri:  (@callback_url or callback_url),
                                                                        client_secret: @app_secret,
@@ -98,43 +101,52 @@ module GraphAPI
   # 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 request(url, access_token)
+  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 setting and the access token for convenience.
-  def request_user(access_token)
-    request("/me?&fields=#{@user_fields.join(',')}", access_token).
-      merge('access_token' => access_token)
-  end
+  # Public: Get and set the facebook access token.
+  attr_accessor :access_token
+  # Public: Get and set a users data based on the current access token.
+  attr_accessor :user_data
 
-  # 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 fetch_user(code, callback_url=nil)
-    access_token = fetch_token(code, callback_url)
-    request_user(access_token)
+  # Public: Creates a new Graph API instance.
+  #
+  # Returns a object representing the current Facebook user with properties
+  # specified in the self.class.user_fields hash array.
+  def initialize(access_token, code=nil, callback_url=nil)
+    @access_token = if not code.nil?
+      self.class.fetch_token(code, callback_url)
+    else
+      access_token
+    end
   end
 
   # Public: Fetches and returns the cover photo src for a Facebook user.
-  #
-  # access_token - This method requires an Facebook Authentication token.
-  def fetch_photo(access_token)
-    albums = request('/me/albums?fields=id,cover_photo,type', access_token)['data']
+  def photo
+    albums = self.class.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']
+    self.class.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 fetch_thumbnail(access_token)
-    request('/me?fields=picture', access_token)['picture']['data']['url']
+  def thumbnail
+    self.picture['data']['url']
   end
 
-  extend self
+  # Public: Meta methods for each of the user fields declared.
+  #
+  # Example:
+  #
+  #   facebook_user = GraphAPI.new(auth_token) # Creates a new user
+  #   puts facebook_user.name                  # Returns the Facebook users full name.
+  def method_missing(method, *args, &block)
+    user_fields = self.class.user_fields << :picture
+    if user_fields.include? method.to_sym
+      @user_data ||= self.class.request("/me?fields=#{user_fields.join(',')}", @access_token)
+      @user_data[method.to_s]
+    else
+      super
+    end
+  end
 end

data/lib/graph_api/version.rb

@@ -1,3 +1,3 @@
-module GraphAPI
-  VERSION = '0.9.7'
+class GraphAPI
+  VERSION = '0.9.8'
 end

data/readme.md

@@ -1,5 +1,6 @@
 # GraphAPI
-GraphAPI is a Ruby Gem containing some common tasks to help manage Facebook users using the Facebook Graph API.
+GraphAPI is a Ruby Gem created to simplifiy and help manage authentication using
+the Facebook Graph API.
 
 ## Usage
 
@@ -11,29 +12,38 @@ Here is how to use it.
 
 ### Set up your Facebook Appications constants
 
-You will have to configure the module before using it. Here is an example setup.
+You will have to configure the gem before using it. Here is an example setup.
 
     GraphAPI.config app_secret:   '124ca2a483f12723cafa7a5da33a3492',      # The Facebook Application Secret
-                    client_id:    '234513432316919',                       # The Facebook Client ID
+                    client_id:    '234513432316919',                       # The Facebook Application Id
                     callback_url: 'http://example.com/facebook_callback/', # URI for receiving the Facebook code param
                     access_scope: [:offline_access, :email, :user_photos], # The Facebook application requirements
                     user_fields:  [:id, :picture, :name, :gender, :email]  # The user fields pulled for
 
-Visit https://developers.facebook.com/apps to register your Facebook application.
+Visit https://developers.facebook.com/apps to register your Facebook application
+or checkout https://developers.facebook.com/docs/reference/api/user/ for a list
+of user fields and permissions.
 
 ### 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.
+Once configured you will be able to use GraphAPI to retrieve any Facebook
+user fields in your application. Here is basic example using Sinatra.
 
     get '/facebook_login' do
       redirect GraphAPI.auth_url
     end
 
     get '/facebook_callback' do
-      @facebook_user = GraphAPI.fetch_user(params[:code])
-      @photo = GraphAPI.fetch_photo(@facebook_user['access_token'])
+      @facebook_user = GraphAPI.new(params[:code])
+      session[:auth_token] = @facebook_user.auth_token
       render :signed_in
     end
 
+    get '/profile'
+      @facebook_user = GraphAPI.new(session[:auth_token])
+      logger.info "User #{@facebook_user.name} viewed their profile."
+      render :profile
+    end
+
 ### License
 WTFPL © 2012 Nick Barth

data/spec/graph_api_spec.rb

@@ -40,10 +40,10 @@ describe GraphAPI do
   describe '#fetch_token' do
     it 'should return the access token' do
       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'
+      RestClient.should_receive(:post).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
@@ -56,37 +56,39 @@ describe GraphAPI do
     end
   end
 
-  describe '#request_user' do
-    it 'should return a user' do
-      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'}
+  describe '#new' do
+    context 'with an access_token param' do
+      it 'should set the auth_token' do
+        GraphAPI.new('ACCESS_TOKEN').access_token.should ==  'ACCESS_TOKEN'
+      end
     end
-  end
 
-  describe '#fetch_user' do
-    it 'should return a user' do
-      GraphAPI.user_fields = [:FIELD1, :FIELD2]
-      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'}
+    context 'with a code param' do
+      it 'should set the auth_token' do
+        GraphAPI.stub(:fetch_token).and_return('ACCESS_TOKEN')
+        GraphAPI.new(nil, 'CODE').access_token.should == 'ACCESS_TOKEN'
+      end
     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'
+  context 'Instance' do
+    describe '#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'})
+        fg_user = GraphAPI.new('ACCESS_TOKEN')
+        fg_user.photo.should == 'PHOTO_URI'
+      end
     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'
+    describe '#thumbnail' do
+      it 'should return a photo URI' do
+        GraphAPI.user_fields = []
+        GraphAPI.should_receive(:request).with('/me?fields=picture', 'ACCESS_TOKEN').and_return({'picture' => {'data' => {'url' => 'PHOTO_URI'}}})
+        fg_user = GraphAPI.new('ACCESS_TOKEN')
+        fg_user.thumbnail.should == 'PHOTO_URI'
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graph-api
 version: !ruby/object:Gem::Version
-  version: 0.9.7
+  version: 0.9.8
   prerelease: 
 platform: ruby
 authors:
@@ -75,8 +75,24 @@ dependencies:
     - - ! '>='
       - !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.
+- !ruby/object:Gem::Dependency
+  name: debugger
+  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 created to simplifiy and help manage authentication
+  using the Facebook Graph API.
 email:
 - nick@nickbarth.ca
 executables: []
@@ -116,7 +132,7 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: A Ruby Gem for common Facebook Graph API tasks.
+summary: A Ruby Gem for simplifying authentication using the Facebook Graph API.
 test_files:
 - graph_api.gemspec
 - spec/graph_api_spec.rb