facebook-stub 0.0.1.1 → 0.0.1.2

data/Readme.md

@@ -54,3 +54,41 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 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.
+
+# Simulating FB Simple Share
+
+      // App code being tested
+      FB.ui({method:'feed', etc:…}, function(){ … })
+
+      // test pseudo code
+      FBWorld.beingPromptedToShare;         //=> false
+      FBWorld.beingPromptedToShareOptions;  //=> null
+      FBWorld.beingPromptedToShareCallback; //=> null
+
+      // do whatever causes the above app code to be called
+      FBWorld.beingPromptedToLogin; //=> true
+      FBWorld.beingPromptedToShareOptions;  //=> {method:'feed', etc:…}
+      FBWorld.beingPromptedToShareCallback; //=> function(){ … }
+
+      // simulate sharing
+      FBWorld.confirmSharePrompt();
+      // the callback is called here with a response stub containing a post id
+
+      FBWorld.beingPromptedToShare;         //=> false
+      FBWorld.beingPromptedToShareOptions;  //=> null
+      FBWorld.beingPromptedToShareCallback; //=> null
+
+      // OR
+
+      // do whatever causes the above app code to be called
+      FBWorld.beingPromptedToLogin; //=> true
+      FBWorld.beingPromptedToShareOptions;  //=> {method:'feed', etc:…}
+      FBWorld.beingPromptedToShareCallback; //=> function(){ … }
+
+      // simulate sharing
+      FBWorld.cancelSharePrompt();
+      // the callback is called here with a response stub not containing a post id
+
+      FBWorld.beingPromptedToShare;         //=> false
+      FBWorld.beingPromptedToShareOptions;  //=> null
+      FBWorld.beingPromptedToShareCallback; //=> null

data/facebook-stub.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |s|
   # specify any dependencies here; for example:
   # s.add_development_dependency "rspec"
   # s.add_runtime_dependency "rest-client"
+  s.add_development_dependency "rake"
 end

data/facebook-stub.js

@@ -9,20 +9,110 @@
     state('appId', data.appId);
   }
 
+  // login
   function login(callback, options) {
     if (calledBeforeInit('login')) return;
     if (FBWorld.state('loggedIn')) {
       console.log('FB.login() called when user is already connected.');
       if (FBWorld.state('connected')) {
         callback(getStatus('standard'));
+        return;
+      }
+    }
+    // simulate being prompted to login
+    FBWorld.beingPromptedToLogin = true;
+    FBWorld.beingPromptedToLoginOptions = options;
+    FBWorld.beingPromptedToLoginCallback = callback;
+  }
+
+
+  // simulates resolving a login prompt in one of three ways
+  function resolveLoginPrompt(successfull, facebook_uid) {
+    if (!FBWorld.beingPromptedToLogin) throw "you are not being prompted to login";
+    var
+      options  = FBWorld.beingPromptedToLoginOptions,
+      callback = FBWorld.beingPromptedToLoginCallback;
+
+    // reset the FBWorld state
+    FBWorld.beingPromptedToLogin = false;
+    FBWorld.beingPromptedToLoginOptions = undefined;
+    FBWorld.beingPromptedToLoginCallback = undefined;
+
+    if (successfull){
+      FBWorld.setUid(facebook_uid);
+      FBWorld.loggedIn();
+
+      if (!FBWorld.state('connected')) {
+        promptToConnect(options, callback);
       } else {
-        simulatePromptToConnect(callback, options);
+        FBWorld.state('perms', 'standard', options.perms);
+        callback(getStatus('standard'));
       }
+
     } else {
-      simulatePromptToLogin(callback, options);
+      FBWorld.notLoggedIn();
+      callback(getStatus());
     }
+  };
+
+  function successfullyLogin(facebook_uid){
+    resolveLoginPrompt(true, facebook_uid);
+  }
+
+  function failToLogin(){
+    resolveLoginPrompt(false);
+  }
+
+  function cancelLogin(){
+    resolveLoginPrompt(false);
+  }
+
+
+  // connect to app
+
+  function promptToConnect(options, callback) {
+    FBWorld.beingPromptedToConnect = true;
+    FBWorld.beingPromptedToConnectOptions = options;
+    FBWorld.beingPromptedToConnectCallback = callback;
   }
 
+  function resolvePromptToConnect(approved) {
+    if (!FBWorld.beingPromptedToConnect) throw "you are not being prompted to connect";
+    var
+      options  = FBWorld.beingPromptedToConnectOptions,
+      callback = FBWorld.beingPromptedToConnectCallback;
+
+      // reset the FBWorld state
+      FBWorld.beingPromptedToConnect = false;
+      FBWorld.beingPromptedToConnectOptions = undefined;
+      FBWorld.beingPromptedToConnectCallback = undefined;
+
+    if (approved){
+      FBWorld.connected();
+      FBWorld.state('perms', 'standard', options.perms);
+    } else {
+      FBWorld.notConnected();
+    }
+
+    callback(getStatus('standard'));
+  }
+
+  function acceptPromptToConnect() {
+    resolvePromptToConnect(true);
+  };
+
+  function denyPromptToConnect() {
+    resolvePromptToConnect(false);
+  };
+
+  function cancelPromptToConnect() {
+    resolvePromptToConnect(false);
+  };
+
+
+
+
+
   function logout(callback) {
     if (calledBeforeInit('logout')) return;
     if (!FBWorld.state('loggedIn')) console.log('FB.logout() called without a session.');
@@ -127,6 +217,38 @@
     return JSON.parse(FBWorld.Helpers.makeMeACookie('fb_friends') || '[]');
   }
 
+
+  // sharing
+
+  function ui(options, callback) {
+    if (options.method === 'feed'){
+      FBWorld.beingPromptedToShare = true;
+      FBWorld.beingPromptedToShareOptions  = options;
+      FBWorld.beingPromptedToShareCallback = callback;
+    }
+  }
+
+  // simulate closing the share prompt by either sharing or canceling
+  function resolveSharePrompt(way) {
+    response = {};
+    if (way === 'share') response.post_id = Math.floor(Math.random() * 100000);
+    if (way === 'cancel');
+
+    if (typeof FBWorld.beingPromptedToShareCallback === 'function')
+      FBWorld.beingPromptedToShareCallback(response);
+    FBWorld.beingPromptedToShare         = false;
+    FBWorld.beingPromptedToShareOptions  = undefined;
+    FBWorld.beingPromptedToShareCallback = undefined;
+  };
+
+  function confirmSharePrompt(){
+    resolveSharePrompt('share');
+  }
+
+  function cancelSharePrompt(){
+    resolveSharePrompt('cancel');
+  }
+
   var XFBML = {
     parse: function(element, callback) {
       callback();
@@ -141,11 +263,16 @@
     getSession     : getSession,
     api            : api,
     XFBML          : XFBML,
-    getUserID      : getUserID
+    getUserID      : getUserID,
+    ui             : ui
   };
 
   FBWorld = { // used to set the state of Facebook
+
+    // the state of the Facebook World
     state                   : state,
+
+    // Set the state of the Facebook World
     loggedIn                : loggedIn,
     notLoggedIn             : notLoggedIn,
     setUid                  : setUid,
@@ -156,22 +283,43 @@
     setExtendedPermissions  : setExtendedPermissions,
 
     initialized                      : false,
-    beingPromptedToLogIn             : false,
-    beingPromptedToLogInCallback     : undefined,
-    // this will come later, no need for it now
-    // successfullyLogin: successfullyLogin,
-    // failToLogin: failToLogin,
 
+    // Simulate interactions with Facebook
+
+    // login
+    beingPromptedToLogin             : false,
+    beingPromptedToLoginOptions      : undefined,
+    beingPromptedToLoginCallback     : undefined,
+    successfullyLogin                : successfullyLogin,
+    failToLogin                      : failToLogin,
+    cancelLogin                      : cancelLogin,
+
+    // connecting
     beingPromptedToConnect           : false,
-    beingPromptedToConnectInCallback : undefined,
-    allowConnection                  : allowConnection,
-    denyConnection                   : denyConnection,
+    beingPromptedToConnectOptions    : undefined,
+    beingPromptedToConnectCallback   : undefined,
+    acceptPromptToConnect            : acceptPromptToConnect,
+    denyPromptToConnect              : denyPromptToConnect,
+    cancelPromptToConnect            : cancelPromptToConnect,
+
+    //sharing
+    beingPromptedToShare             : false,
+    beingPromptedToShareOptions      : undefined,
+    beingPromptedToShareCallback     : undefined,
+    confirmSharePrompt               : confirmSharePrompt,
+    cancelSharePrompt                : cancelSharePrompt,
 
     //friends
     addFriend                        : addFriend,
     friendList                       : friendList
   };
 
+
+
+
+
+
+
   // PRIVATE FUNCTIONS
 
   function getStatus(permissions) {
@@ -216,52 +364,6 @@
     return true;
   }
 
-  function simulatePromptToLogin(callback, options) {
-    // simulate being prompted to log in
-    FBWorld.beingPromptedToLogIn = true;
-    FBWorld.beingPromptedToLogInCallback = function(approved) {
-      FBWorld.beingPromptedToLogin = false;
-      FBWorld.beingPromptedToLoginCallback = undefined;
-      if(approved) {
-        FBWorld.loggedIn();
-        if (!FBWorld.state('connected')) {
-          simulatePromptToConnect(callback, options);
-        } else {
-          FBWorld.state('perms', 'standard', options.perms);
-          callback(getStatus('standard'));
-        }
-      } else {
-        FBWorld.notLoggedIn();
-        callback(getStatus());
-      }
-
-    };
-  };
-
-  function simulatePromptToConnect(callback, options) {
-    // simulate being prompted to connect
-    FBWorld.beingPromptedToConnect = true;
-    FBWorld.beingPromptedToConnectCallback = function(approved) {
-      approved ? FBWorld.connected() : FBWorld.notConnected();
-      FBWorld.beingPromptedToConnect = false;
-      FBWorld.beingPromptedToConnectCallback = undefined;
-      if (approved) {
-        FBWorld.state('perms', 'standard', options.perms);
-      }
-      callback(getStatus('standard'));
-    };
-  };
-
-  function allowConnection() {
-    if (!FBWorld.beingPromptedToConnect) throw "you are not being prompted to connect";
-    FBWorld.beingPromptedToConnectCallback(true);
-  };
-
-  function denyConnection() {
-    if (!FBWorld.beingPromptedToConnect) throw "you are not being prompted to connect";
-    FBWorld.beingPromptedToConnectCallback(false);
-  };
-
   var cookieOptions = { path: '/', domain: window.location.hostname.replace(/^www/, '')};
 
   // cookie looks like this: (with the quotes): "access_token=theToken&base_domain=local-change.org&expires=0&secret=theSecret&session_key=theSessionKeysig=theSig-Hashed&uid=theUID"

data/lib/facebook-stub/version.rb

@@ -1,5 +1,5 @@
 module Facebook
   module Stub
-    VERSION = "0.0.1.1"
+    VERSION = "0.0.1.2"
   end
 end

data/src/facebook.js

@@ -9,20 +9,110 @@
     state('appId', data.appId);
   }
 
+  // login
   function login(callback, options) {
     if (calledBeforeInit('login')) return;
     if (FBWorld.state('loggedIn')) {
       console.log('FB.login() called when user is already connected.');
       if (FBWorld.state('connected')) {
         callback(getStatus('standard'));
+        return;
+      }
+    }
+    // simulate being prompted to login
+    FBWorld.beingPromptedToLogin = true;
+    FBWorld.beingPromptedToLoginOptions = options;
+    FBWorld.beingPromptedToLoginCallback = callback;
+  }
+
+
+  // simulates resolving a login prompt in one of three ways
+  function resolveLoginPrompt(successfull, facebook_uid) {
+    if (!FBWorld.beingPromptedToLogin) throw "you are not being prompted to login";
+    var
+      options  = FBWorld.beingPromptedToLoginOptions,
+      callback = FBWorld.beingPromptedToLoginCallback;
+
+    // reset the FBWorld state
+    FBWorld.beingPromptedToLogin = false;
+    FBWorld.beingPromptedToLoginOptions = undefined;
+    FBWorld.beingPromptedToLoginCallback = undefined;
+
+    if (successfull){
+      FBWorld.setUid(facebook_uid);
+      FBWorld.loggedIn();
+
+      if (!FBWorld.state('connected')) {
+        promptToConnect(options, callback);
       } else {
-        simulatePromptToConnect(callback, options);
+        FBWorld.state('perms', 'standard', options.perms);
+        callback(getStatus('standard'));
       }
+
+    } else {
+      FBWorld.notLoggedIn();
+      callback(getStatus());
+    }
+  };
+
+  function successfullyLogin(facebook_uid){
+    resolveLoginPrompt(true, facebook_uid);
+  }
+
+  function failToLogin(){
+    resolveLoginPrompt(false);
+  }
+
+  function cancelLogin(){
+    resolveLoginPrompt(false);
+  }
+
+
+  // connect to app
+
+  function promptToConnect(options, callback) {
+    FBWorld.beingPromptedToConnect = true;
+    FBWorld.beingPromptedToConnectOptions = options;
+    FBWorld.beingPromptedToConnectCallback = callback;
+  }
+
+  function resolvePromptToConnect(approved) {
+    if (!FBWorld.beingPromptedToConnect) throw "you are not being prompted to connect";
+    var
+      options  = FBWorld.beingPromptedToConnectOptions,
+      callback = FBWorld.beingPromptedToConnectCallback;
+
+      // reset the FBWorld state
+      FBWorld.beingPromptedToConnect = false;
+      FBWorld.beingPromptedToConnectOptions = undefined;
+      FBWorld.beingPromptedToConnectCallback = undefined;
+
+    if (approved){
+      FBWorld.connected();
+      FBWorld.state('perms', 'standard', options.perms);
     } else {
-      simulatePromptToLogin(callback, options);
+      FBWorld.notConnected();
     }
+
+    callback(getStatus('standard'));
   }
 
+  function acceptPromptToConnect() {
+    resolvePromptToConnect(true);
+  };
+
+  function denyPromptToConnect() {
+    resolvePromptToConnect(false);
+  };
+
+  function cancelPromptToConnect() {
+    resolvePromptToConnect(false);
+  };
+
+
+
+
+
   function logout(callback) {
     if (calledBeforeInit('logout')) return;
     if (!FBWorld.state('loggedIn')) console.log('FB.logout() called without a session.');
@@ -127,6 +217,38 @@
     return JSON.parse(FBWorld.Helpers.makeMeACookie('fb_friends') || '[]');
   }
 
+
+  // sharing
+
+  function ui(options, callback) {
+    if (options.method === 'feed'){
+      FBWorld.beingPromptedToShare = true;
+      FBWorld.beingPromptedToShareOptions  = options;
+      FBWorld.beingPromptedToShareCallback = callback;
+    }
+  }
+
+  // simulate closing the share prompt by either sharing or canceling
+  function resolveSharePrompt(way) {
+    response = {};
+    if (way === 'share') response.post_id = Math.floor(Math.random() * 100000);
+    if (way === 'cancel');
+
+    if (typeof FBWorld.beingPromptedToShareCallback === 'function')
+      FBWorld.beingPromptedToShareCallback(response);
+    FBWorld.beingPromptedToShare         = false;
+    FBWorld.beingPromptedToShareOptions  = undefined;
+    FBWorld.beingPromptedToShareCallback = undefined;
+  };
+
+  function confirmSharePrompt(){
+    resolveSharePrompt('share');
+  }
+
+  function cancelSharePrompt(){
+    resolveSharePrompt('cancel');
+  }
+
   var XFBML = {
     parse: function(element, callback) {
       callback();
@@ -141,11 +263,16 @@
     getSession     : getSession,
     api            : api,
     XFBML          : XFBML,
-    getUserID      : getUserID
+    getUserID      : getUserID,
+    ui             : ui
   };
 
   FBWorld = { // used to set the state of Facebook
+
+    // the state of the Facebook World
     state                   : state,
+
+    // Set the state of the Facebook World
     loggedIn                : loggedIn,
     notLoggedIn             : notLoggedIn,
     setUid                  : setUid,
@@ -156,22 +283,43 @@
     setExtendedPermissions  : setExtendedPermissions,
 
     initialized                      : false,
-    beingPromptedToLogIn             : false,
-    beingPromptedToLogInCallback     : undefined,
-    // this will come later, no need for it now
-    // successfullyLogin: successfullyLogin,
-    // failToLogin: failToLogin,
 
+    // Simulate interactions with Facebook
+
+    // login
+    beingPromptedToLogin             : false,
+    beingPromptedToLoginOptions      : undefined,
+    beingPromptedToLoginCallback     : undefined,
+    successfullyLogin                : successfullyLogin,
+    failToLogin                      : failToLogin,
+    cancelLogin                      : cancelLogin,
+
+    // connecting
     beingPromptedToConnect           : false,
-    beingPromptedToConnectInCallback : undefined,
-    allowConnection                  : allowConnection,
-    denyConnection                   : denyConnection,
+    beingPromptedToConnectOptions    : undefined,
+    beingPromptedToConnectCallback   : undefined,
+    acceptPromptToConnect            : acceptPromptToConnect,
+    denyPromptToConnect              : denyPromptToConnect,
+    cancelPromptToConnect            : cancelPromptToConnect,
+
+    //sharing
+    beingPromptedToShare             : false,
+    beingPromptedToShareOptions      : undefined,
+    beingPromptedToShareCallback     : undefined,
+    confirmSharePrompt               : confirmSharePrompt,
+    cancelSharePrompt                : cancelSharePrompt,
 
     //friends
     addFriend                        : addFriend,
     friendList                       : friendList
   };
 
+
+
+
+
+
+
   // PRIVATE FUNCTIONS
 
   function getStatus(permissions) {
@@ -216,52 +364,6 @@
     return true;
   }
 
-  function simulatePromptToLogin(callback, options) {
-    // simulate being prompted to log in
-    FBWorld.beingPromptedToLogIn = true;
-    FBWorld.beingPromptedToLogInCallback = function(approved) {
-      FBWorld.beingPromptedToLogin = false;
-      FBWorld.beingPromptedToLoginCallback = undefined;
-      if(approved) {
-        FBWorld.loggedIn();
-        if (!FBWorld.state('connected')) {
-          simulatePromptToConnect(callback, options);
-        } else {
-          FBWorld.state('perms', 'standard', options.perms);
-          callback(getStatus('standard'));
-        }
-      } else {
-        FBWorld.notLoggedIn();
-        callback(getStatus());
-      }
-
-    };
-  };
-
-  function simulatePromptToConnect(callback, options) {
-    // simulate being prompted to connect
-    FBWorld.beingPromptedToConnect = true;
-    FBWorld.beingPromptedToConnectCallback = function(approved) {
-      approved ? FBWorld.connected() : FBWorld.notConnected();
-      FBWorld.beingPromptedToConnect = false;
-      FBWorld.beingPromptedToConnectCallback = undefined;
-      if (approved) {
-        FBWorld.state('perms', 'standard', options.perms);
-      }
-      callback(getStatus('standard'));
-    };
-  };
-
-  function allowConnection() {
-    if (!FBWorld.beingPromptedToConnect) throw "you are not being prompted to connect";
-    FBWorld.beingPromptedToConnectCallback(true);
-  };
-
-  function denyConnection() {
-    if (!FBWorld.beingPromptedToConnect) throw "you are not being prompted to connect";
-    FBWorld.beingPromptedToConnectCallback(false);
-  };
-
   var cookieOptions = { path: '/', domain: window.location.hostname.replace(/^www/, '')};
 
   // cookie looks like this: (with the quotes): "access_token=theToken&base_domain=local-change.org&expires=0&secret=theSecret&session_key=theSessionKeysig=theSig-Hashed&uid=theUID"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: facebook-stub
 version: !ruby/object:Gem::Version 
-  hash: 73
+  hash: 79
   prerelease: 
   segments: 
   - 0
   - 0
   - 1
-  - 1
-  version: 0.0.1.1
+  - 2
+  version: 0.0.1.2
 platform: ruby
 authors: 
 - Change.org
@@ -16,10 +16,22 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-20 00:00:00 -08:00
-default_executable: 
-dependencies: []
-
+date: 2012-04-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+  prerelease: false
+  name: rake
+  type: :development
 description: facebook-stub is a gem for stubbing out the Facebook JavaScript API in acceptance and integration tests.
 email: 
 - techops@change.org
@@ -46,7 +58,6 @@ files:
 - src/libs/sha256.js
 - src/libs/utf8_encode.js
 - test/test.html
-has_rdoc: true
 homepage: ""
 licenses: []
 
@@ -76,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: facebook-stub
-rubygems_version: 1.5.3
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Stub out the FB JS API