graph-api 0.9.5 → 0.9.6

data/graph_api.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   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.homepage      = 'https://github.com/nickbarth/GraphAPI'
 
   gem.add_dependency('rake')
   gem.add_dependency('json')

data/lib/graph_api.rb

@@ -1,73 +1,79 @@
 require 'json'
 require 'rest_client'
+require 'graph_api/version'
 
 # Public: Various methods useful for interfacing with Facebook Graph protocol.
 #
 # Example:
 #
 #   get '/facebook_login' do
-#     redirect FaceGraph::auth_url
+#     redirect FaceGraph.auth_url
 #   end
 #
 #   get '/facebook_auth' do
-#     @facebook_user = GraphAPI::fetch_user(params[:code])
-#     @photo = GraphAPI::fetch_photo(@facebook_user['access_token'])
+#     @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.
+  # Public: Required setting used for Facebook private application secret.
   #
   # Example:
   #
-  # APP_SECRET = '124ca2a483f12723cafa7a5da33a3492'
+  # @app_secret = '124ca2a483f12723cafa7a5da33a3492'
+  attr_accessor :app_secret
 
-  # Public: Required constant used for Facebook private application client ID.
+  # Public: Required setting used for Facebook private application client ID.
   #
   # Example
   #
-  # CLIENT_ID  = '234513432316919'
+  # @client_id  = '234513432316919'
+  attr_accessor :client_id
 
-  # Public: Reqired constant used for Facebook call back URL when receiving the Facebook connect code param.
+  # Public: Reqired setting used for Facebook call back URL when receiving the Facebook connect code param.
   #
   # Example
   #
-  # CALLBACK_URL = nil
+  # @callback_url = nil
+  attr_accessor :callback_url
 
-  # Public: Required constant used for setting Facebook application requirements.
+  # Public: Required setting used for setting Facebook application requirements.
   #
   # Example
   #
-  # ACCESS_SCOPE = [:offline_access, :email, :user_photos, :user_location, :user_about_me]
+  # @access_scope = [:offline_access, :email, :user_photos, :user_location, :user_about_me]
+  attr_accessor :access_scope
 
-  # Public: Required constant used for setting the fields pulled for.
+  # Public: Required setting used for setting the fields pulled for.
   #
   # Example
   #
-  # USER_FIELDS = [:id, :picture, :name, :gender, :link, :email, :verified, :bio]
+  # @user_fields = [:id, :picture, :name, :gender, :link, :email, :verified, :bio]
+  attr_accessor :user_fields
 
-  # Public: Method for configuring the setting constants for a nicer syntax.
+  # Public: Method for configuring the setting settings for a nicer syntax.
   #
   # Example:
   #
-  # GraphAPI.config APP_SECRET: '124ca2a483f12723cafa7a5da33a3492',
-  #                 CLIENT_ID:  '234513432316919'
+  # GraphAPI.config app_secret: '124ca2a483f12723cafa7a5da33a3492',
+  #                 client_id:  '234513432316919'
   #
-  def config(consts)
-    consts.each do |const, value|
-      const_set(const.to_s, value)
+  def config(settings)
+    settings.each do |setting, value|
+      self.send("#{setting}=", value)
     end
   end
 
-  # Public: Creates and returns a Facebook Authentication URL based on the supplied constants.
+  # Public: Creates and returns a Facebook Authentication URL based on the supplied settings.
   #
-  # callback_url - With CALLBACK_URL set to nil setting this parameter will use
+  # 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)
-    "https://graph.facebook.com/oauth/authorize?client_id=#{CLIENT_ID}" +
-    "&redirect_uri=#{CALLBACK_URL or callback_url}" +
-    "&scope=#{ACCESS_SCOPE.join(',')}"
+    "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.
@@ -75,13 +81,13 @@ module GraphAPI
   # 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
+  # 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)
-    RestClient.get('https://graph.facebook.com/oauth/access_token', { client_id:     CLIENT_ID,
-                                                                      redirect_uri:  (CALLBACK_URL or callback_url),
-                                                                      client_secret: APP_SECRET,
+    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
@@ -97,16 +103,16 @@ module GraphAPI
   end
 
   # Public: Returns a Facebook user array containing the fields set by the
-  #         USER_FIELDS constant and the access token for convenience.
+  #         @user_fields setting and the access token for convenience.
   def request_user(access_token)
-    request("/me?&fields=#{USER_FIELDS.join(',')}", 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
+  # 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)

data/lib/graph_api/version.rb

@@ -1,3 +1,3 @@
 module GraphAPI
-  VERSION = '0.9.5'
+  VERSION = '0.9.6'
 end

data/readme.md

@@ -13,23 +13,23 @@ Here is how to use it.
 
 You will have to configure the module before using it. Here is an example setup.
 
-    GraphAPI.config APP_SECRET:   '124ca2a483f12723cafa7a5da33a3492'                      # Constant required for setting the Facebook Application Secret
-                    CLIENT_ID:    '234513432316919'                                       # Constant required for setting the Facebook Client ID
-                    CALLBACK_URL: 'http://example.com/facebook_callback/'                 # Constant required for when receiving the Facebook connect code param
-                    ACCESS_SCOPE: [:offline_access, :email, :user_photos, :user_location] # Constant required for setting Facebook application requirements
-                    USER_FIELDS:  [:id, :picture, :name, :gender, :link, :email]          # Constant required for setting the user fields pulled for
+    GraphAPI.config app_secret:   '124ca2a483f12723cafa7a5da33a3492'                      # The Facebook Application Secret
+                    client_id:    '234513432316919'                                       # The Facebook Client ID
+                    callback_url: 'http://example.com/facebook_callback/'                 # URI for receiving the Facebook connect code param
+                    access_scope: [:offline_access, :email, :user_photos, :user_location] # The Facebook application requirements
+                    user_fields:  [:id, :picture, :name, :gender, :link, :email]          # The user fields pulled for
 
 ### 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
+      redirect FaceGraph.auth_url
     end
 
     get '/facebook_auth' do
-      @facebook_user = GraphAPI::fetch_user(params[:code])
-      @photo = GraphAPI::fetch_photo(@facebook_user['access_token'])
+      @facebook_user = GraphAPI.fetch_user(params[:code])
+      @photo = GraphAPI.fetch_photo(@facebook_user['access_token'])
       render :signed_in
     end
 

data/spec/graph_api_spec.rb

@@ -7,38 +7,39 @@ describe GraphAPI do
 
   describe '#config' do
     it 'should configuration constants to be set' do
-      GraphAPI.config APP_SECRET:   'APP_SECRET',
-                      CLIENT_ID:    'CLIENT_ID',
-                      CALLBACK_URL: 'CALLBACK_URL',
-                      ACCESS_SCOPE: 'ACCESS_SCOPE',
-                      USER_FIELDS:  'USER_FIELDS'
-      GraphAPI::APP_SECRET.should   == 'APP_SECRET'
-      GraphAPI::CLIENT_ID.should    == 'CLIENT_ID'
-      GraphAPI::CALLBACK_URL.should == 'CALLBACK_URL'
-      GraphAPI::ACCESS_SCOPE.should == 'ACCESS_SCOPE'
-      GraphAPI::USER_FIELDS.should  == 'USER_FIELDS'
+      GraphAPI.config app_secret:   'APP_SECRET',
+                      client_id:    'CLIENT_ID',
+                      callback_url: 'CALLBACK_URL',
+                      access_scope: 'ACCESS_SCOPE',
+                      user_fields:  'USER_FIELDS'
+
+      GraphAPI.app_secret.should   == 'APP_SECRET'
+      GraphAPI.client_id.should    == 'CLIENT_ID'
+      GraphAPI.callback_url.should == 'CALLBACK_URL'
+      GraphAPI.access_scope.should == 'ACCESS_SCOPE'
+      GraphAPI.user_fields.should  == 'USER_FIELDS'
     end
   end
 
   describe '#auth_url' do
     before(:each) do
-      stub_const('GraphAPI::ACCESS_SCOPE', [:SCOPE1, :SCOPE2])
+      GraphAPI.access_scope = [:SCOPE1, :SCOPE2]
     end
 
     it 'should use generate a URI' do
-      stub_const('GraphAPI::CALLBACK_URL', nil)
+      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.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')
+      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',
@@ -57,7 +58,7 @@ describe GraphAPI do
 
   describe '#request_user' do
     it 'should return a user' do
-      stub_const('GraphAPI::USER_FIELDS', [:FIELD1, :FIELD2])
+      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
@@ -65,8 +66,8 @@ describe GraphAPI do
 
   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.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'}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graph-api
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.9.6
   prerelease: 
 platform: ruby
 authors:
@@ -93,7 +93,7 @@ files:
 - readme.md
 - spec/graph_api_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/nickbarth/RakeAR
+homepage: https://github.com/nickbarth/GraphAPI
 licenses: []
 post_install_message: 
 rdoc_options: []