diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..d3f7b6dd --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +*.iml +.idea +.DS_Store diff --git a/Example/index.html b/Example/index.html deleted file mode 100755 index 2500876e..00000000 --- a/Example/index.html +++ /dev/null @@ -1,96 +0,0 @@ - - - - com.PhoneGap.c2dm - - - - - - - -
- -
- - \ No newline at end of file diff --git a/Example/pushGCM.rb b/Example/pushGCM.rb deleted file mode 100644 index 45b870a1..00000000 --- a/Example/pushGCM.rb +++ /dev/null @@ -1,8 +0,0 @@ -require 'rubygems' -require 'pushmeup' -GCM.host = 'https://android.googleapis.com/gcm/send' -GCM.format = :json -GCM.key = "AIzaSyB9bWG4OL5-m0eSE5PYaOhsE4lvKwpWBeg" -destination = ["APA91bHi2_juaN9NMBn8bh2rzC-VTg47E8DckJzxVyVr8zxOHI-IswZZibeyyNQo6Wj9u7XVHs_eizoILByPODGtYo71O0qjGaqOoloq6fRBc8DyhQCR1KmZY6qOlUJAKqE21pD5VGN9"] -data = {:message => "this is a test", :msgcnt => "1"} -GCM.send_notification( destination, data) diff --git a/Example/pushAPNS.rb b/Example/server/pushAPNS.rb similarity index 100% rename from Example/pushAPNS.rb rename to Example/server/pushAPNS.rb diff --git a/Example/server/pushGCM.rb b/Example/server/pushGCM.rb new file mode 100644 index 00000000..e1efce5e --- /dev/null +++ b/Example/server/pushGCM.rb @@ -0,0 +1,9 @@ +require 'rubygems' +require 'pushmeup' +GCM.host = 'https://android.googleapis.com/gcm/send' +GCM.format = :json +GCM.key = "API_KEY_GOES_HERE" +destination = ["REGISTRATION_ID_GOES_HERE"] +data = {:message => "PhoneGap Build rocks!", :msgcnt => "1", :soundname => "beep.wav"} + +GCM.send_notification( destination, data) diff --git a/Example/www/PushNotification.js b/Example/www/PushNotification.js new file mode 100644 index 00000000..6b51bade --- /dev/null +++ b/Example/www/PushNotification.js @@ -0,0 +1,65 @@ + +var PushNotification = function() { +}; + + + // Call this to register for push notifications. Content of [options] depends on whether we are working with APNS (iOS) or GCM (Android) + PushNotification.prototype.register = function(successCallback, errorCallback, options) { + if (errorCallback == null) { errorCallback = function() {}} + + if (typeof errorCallback != "function") { + console.log("PushNotification.register failure: failure parameter not a function"); + return; + } + + if (typeof successCallback != "function") { + console.log("PushNotification.register failure: success callback parameter must be a function"); + return; + } + + cordova.exec(successCallback, errorCallback, "PushPlugin", "register", [options]); + }; + + // Call this to unregister for push notifications + PushNotification.prototype.unregister = function(successCallback, errorCallback) { + if (errorCallback == null) { errorCallback = function() {}} + + if (typeof errorCallback != "function") { + console.log("PushNotification.unregister failure: failure parameter not a function"); + return; + } + + if (typeof successCallback != "function") { + console.log("PushNotification.unregister failure: success callback parameter must be a function"); + return; + } + + cordova.exec(successCallback, errorCallback, "PushPlugin", "unregister", []); + }; + + + // Call this to set the application icon badge + PushNotification.prototype.setApplicationIconBadgeNumber = function(successCallback, badge) { + if (errorCallback == null) { errorCallback = function() {}} + + if (typeof errorCallback != "function") { + console.log("PushNotification.setApplicationIconBadgeNumber failure: failure parameter not a function"); + return; + } + + if (typeof successCallback != "function") { + console.log("PushNotification.setApplicationIconBadgeNumber failure: success callback parameter must be a function"); + return; + } + + cordova.exec(successCallback, successCallback, "PushPlugin", "setApplicationIconBadgeNumber", [{badge: badge}]); + }; + +//------------------------------------------------------------------- + +if(!window.plugins) { + window.plugins = {}; +} +if (!window.plugins.pushNotification) { + window.plugins.pushNotification = new PushNotification(); +} diff --git a/Example/beep.wav b/Example/www/beep.wav similarity index 100% rename from Example/beep.wav rename to Example/www/beep.wav diff --git a/Example/www/index.html b/Example/www/index.html new file mode 100755 index 00000000..681e9e72 --- /dev/null +++ b/Example/www/index.html @@ -0,0 +1,146 @@ + + + + com.PhoneGap.c2dm + + + + + + + + + +
+
+ +
+
+ + \ No newline at end of file diff --git a/Example/jquery_1.5.2.min.js b/Example/www/jquery_1.5.2.min.js similarity index 100% rename from Example/jquery_1.5.2.min.js rename to Example/www/jquery_1.5.2.min.js diff --git a/README.md b/README.md index fc4fa2e0..d644250e 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,30 @@ -# Cordova Push Notifications Plugin for Android and iOS +# Cordova Push Notifications Plugin for Android, iOS and WP8 --- ## DESCRIPTION -This plugin is for use with [Cordova](http://incubator.apache.org/cordova/), and allows your application to receive push notifications on both Android and iOS devices. The Android implementation uses [Google's GCM (Google Cloud Messaging) service](http://developer.android.com/guide/google/gcm/index.html), whereas the iOS version is based on [Apple APNS Notifications](http://developer.android.com/guide/google/gcm/index.html) +This plugin is for use with [Cordova](http://incubator.apache.org/cordova/), and allows your application to receive push notifications on both Android and iOS devices. The Android implementation uses [Google's GCM (Google Cloud Messaging) service](http://developer.android.com/guide/google/gcm/index.html), whereas the iOS version is based on [Apple APNS Notifications](http://developer.apple.com/library/mac/#documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/ApplePushService/ApplePushService.html) **Important** - Push notifications are intended for real devices. The registration process will fail on the iOS simulator. Notifications can be made to work on the Android Emulator. However, doing so requires installation of some helper libraries, as outlined [here,](http://www.androidhive.info/2012/10/android-push-notifications-using-google-cloud-messaging-gcm-php-and-mysql/) under the section titled "Installing helper libraries and setting up the Emulator". ## LICENSE The MIT License - + Copyright (c) 2012 Adobe Systems, inc. portions Copyright (c) 2012 Olivier Louvignes - + Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: - + 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 @@ -35,70 +35,142 @@ This plugin is for use with [Cordova](http://incubator.apache.org/cordova/), and ## Manual Installation for Android -Add the **com.google.android.gcm** and **com.plugin.GCM** packages to your project's src directory. -Modify your **AndroidManifest.xml** and add the following lines to your manifest tag, replacing **your_app_package** with your app's package path: +1) copy the contents of **src/android/com/** to your project's **src/com/** folder. + copy the contents of **libs/** to your **libs/** folder. + copy **{android_sdk_path}/extras/android/support/v13/android-support-v13.jar** to your **libs/** folder. + The final hierarchy will likely look something like this: + + {project_folder} + libs + gcm.jar + android-support-v13.jar + cordova-3.4.0.jar + src + com + plugin + gcm + CordovaGCMBroadcastReceiver.java + GCMIntentService.java + PushHandlerActivity.java + PushPlugin.java + {company_name} + {intent_name} + {intent_name}.java + +2) Modify your **AndroidManifest.xml** and add the following lines to your manifest tag: + +```xml + + + + + + +``` + +3) Modify your **AndroidManifest.xml** and add the following **activity**, **receiver** and **service** tags to your **application** section. (See the Sample_AndroidManifest.xml file in the Example folder.) + +```xml + + + + + + + + + +``` + +4) Modify your **res/xml/config.xml** to include the following line in order to tell Cordova to include this plugin and where it can be found: (See the Sample_config.xml file in the Example folder) + +```xml + + + +``` + +5) Add the **PushNotification.js** script to your assets/www folder (or javascripts folder, wherever you want really) and reference it in your main index.html file. This file's usage is described in the **Plugin API** section below. + +```html + +``` + +## Manual Installation for iOS + +Copy the following files to your project's Plugins folder: +``` +AppDelegate+notification.h +AppDelegate+notification.m +PushPlugin.h +PushPlugin.m +``` - - - - - +Add a reference for this plugin to the plugins section in **config.xml**: +```xml + + + +``` -Modify your **AndroidManifest.xml** and add the following lines to your application tag, replacing **your_app_package** with your app's package path: +Add the **PushNotification.js** script to your assets/www folder (or javascripts folder, wherever you want really) and reference it in your main index.html file. +```html + +``` - - - - - - - +## Manual Installation for WP8 - +Copy the following files to your project's Commands folder and add it to the VS project: +``` +PushPlugin.cs +``` -Modify your **res/xml/plugins.xml** to include the following line in order to tell Cordova to include this plugin and where it can be found: +Add a reference to this plugin in **config.xml**: - +```xml + + + +``` Add the **PushNotification.js** script to your assets/www folder (or javascripts folder, wherever you want really) and reference it in your main index.html file. +```html + +``` - +## Automatic Installation +This plugin is based on [plugman](https://github.com/apache/cordova-plugman). to install it to your app, +simply execute plugman as follows; -## Manual Installation for iOS +```sh +plugman install --platform [PLATFORM] --project [TARGET-PATH] --plugin [PLUGIN-PATH] -Copy the following files to your project's Plugins folder: +where + [PLATFORM] = ios or android + [TARGET-PATH] = path to folder containing your phonegap project + [PLUGIN-PATH] = path to folder containing this plugin +``` - AppDelegate+notification.h - AppDelegate+notification.m - PushPlugin.h - PushPlugin.m - -Add a reference for this plugin to the plugins dictionary in **Cordove.plist**: +Alternatively this plugin can be installed using the Phonegap CLI: - PushPlugin - PushPlugin +```sh +phonegap local plugin add https://github.com/phonegap-build/PushPlugin.git -Add the **PushNotification.js** script to your assets/www folder (or javascripts folder, wherever you want really) and reference it in your main index.html file. +``` - +or the Cordova CLI: -## Automatic Installation -This plugin is based on [pluginstall](https://github.com/alunny/pluginstall). to install it to your app, -simply execute pluginstall as follows; +```sh +cordova plugin add https://github.com/phonegap-build/PushPlugin.git - pluginstall [PLATFORM] [TARGET-PATH] [PLUGIN-PATH] - - where - [PLATFORM] = ios or android - [TARGET-PATH] = path to folder containing your phonegap project - [PLUGIN-PATH] = path to folder containing this plugin +``` -For additional info, take a look at the [Cordova Pluginstall Specification](https://github.com/alunny/cordova-plugin-spec) +For additional info, take a look at the [Plugman Documentation](https://github.com/apache/cordova-plugman/blob/master/README.md) ## Plugin API @@ -106,103 +178,248 @@ In the Examples folder you will find a sample implementation showing how to inte First create the plugin instance variable. - var pushNotification; - +```js +var pushNotification; +``` + When deviceReady fires, get the plugin reference - pushNotification = window.plugins.pushNotification; - +```js +pushNotification = window.plugins.pushNotification; +``` + #### register This should be called as soon as the device becomes ready. On success, you will get a call to tokenHandler (iOS), or onNotificationGCM (Android), allowing you to obtain the device token or registration ID, respectively. Those values will typically get posted to your intermediary push server so it knows who it can send notifications to. - if (device.platform == 'android' || device.platform == 'Android') { - pushNotification.register(successHandler, errorHandler,{"senderID":"661780372179","ecb":"onNotificationGCM"}); - } else { - pushNotification.register(tokenHandler, errorHandler {"badge":"true","sound":"true","alert":"true","ecb":"onNotificationAPN"}); - } - + +For Android, If you have not already done so, you'll need to set up a Google API project, to generate your senderID. [Follow these steps](http://developer.android.com/guide/google/gcm/gs.html) to do so. This is described more fully in the **Test Environment** section below. + +In this example, be sure and substitute your own senderID. Get your senderID by signing into to your [google dashboard](https://code.google.com/apis/console/). The senderID is found at **Overview->Dashboard->Project Number**. + +```js +if ( device.platform == 'android' || device.platform == 'Android' ) +{ + pushNotification.register( + successHandler, + errorHandler, { + "senderID":"replace_with_sender_id", + "ecb":"onNotificationGCM" + }); +} +else +{ + pushNotification.register( + tokenHandler, + errorHandler, { + "badge":"true", + "sound":"true", + "alert":"true", + "ecb":"onNotificationAPN" + }); +} +``` **successHandler** - called when a plugin method returns without error - // result contains any message sent from the plugin call - function successHandler (result) { - alert('result = '+result) - } - +```js +// result contains any message sent from the plugin call +function successHandler (result) { + alert('result = ' + result); +} +``` + **errorHandler** - called when the plugin returns an error - // result contains any error description text returned from the plugin call - function errorHandler (error) { - alert('error = '+error) - } - -**tokenHandler (iOS ony)** - called when the device has registeredwith a unique device token. +```js +// result contains any error description text returned from the plugin call +function errorHandler (error) { + alert('error = ' + error); +} +``` - function tokenHandler (result) { - // Your iOS push server needs to know the token before it can push to this device - // here is where you might want to send it the token for later use. - alert('device token = '+result) - } +**tokenHandler (iOS only)** - called when the device has registered with a unique device token. + +```js +function tokenHandler (result) { + // Your iOS push server needs to know the token before it can push to this device + // here is where you might want to send it the token for later use. + alert('device token = ' + result); +} +``` **senderID (Android only)** - This is the Google project ID you need to obtain by [registering your application](http://developer.android.com/guide/google/gcm/gs.html) for GCM **ecb** - event callback that gets called when your device receives a notification - - // iOS - function onNotificationAPN(event) { - if (event.alert) { - navigator.notification.alert(event.alert); + +```js +// iOS +function onNotificationAPN (event) { + if ( event.alert ) + { + navigator.notification.alert(event.alert); + } + + if ( event.sound ) + { + var snd = new Media(event.sound); + snd.play(); + } + + if ( event.badge ) + { + pushNotification.setApplicationIconBadgeNumber(successHandler, errorHandler, event.badge); + } +} + +// Android +function onNotificationGCM(e) { + $("#app-status-ul").append('
  • EVENT -> RECEIVED:' + e.event + '
  • '); + + switch( e.event ) + { + case 'registered': + if ( e.regid.length > 0 ) + { + $("#app-status-ul").append('
  • REGISTERED -> REGID:' + e.regid + "
  • "); + // Your GCM push server needs to know the regID before it can push to this device + // here is where you might want to send it the regID for later use. + console.log("regID = " + e.regid); } - - if (event.sound) { - var snd = new Media(event.sound); - snd.play(); + break; + + case 'message': + // if this flag is set, this notification happened while we were in the foreground. + // you might want to play a sound to get the user's attention, throw up a dialog, etc. + if ( e.foreground ) + { + $("#app-status-ul").append('
  • --INLINE NOTIFICATION--' + '
  • '); + + // if the notification contains a soundname, play it. + var my_media = new Media("/android_asset/www/"+e.soundname); + my_media.play(); } - - if (event.badge) { - pushNotification.setApplicationIconBadgeNumber(successHandler, event.badge); + else + { // otherwise we were launched because the user touched a notification in the notification tray. + if ( e.coldstart ) + { + $("#app-status-ul").append('
  • --COLDSTART NOTIFICATION--' + '
  • '); + } + else + { + $("#app-status-ul").append('
  • --BACKGROUND NOTIFICATION--' + '
  • '); + } } - } + $("#app-status-ul").append('
  • MESSAGE -> MSG: ' + e.payload.message + '
  • '); + $("#app-status-ul").append('
  • MESSAGE -> MSGCNT: ' + e.payload.msgcnt + '
  • '); + break; + + case 'error': + $("#app-status-ul").append('
  • ERROR -> MSG:' + e.msg + '
  • '); + break; + + default: + $("#app-status-ul").append('
  • EVENT -> Unknown, an event was received and we do not know what it is
  • '); + break; + } +} +``` + +Looking at the above message handling code for Android, a few things bear explaination. Your app may receive a notification while it is active (INLINE). If you background the app by hitting the Home button on your device, you may later receive a status bar notification. Selecting that notification from the status will bring your app to the front and allow you to process the notification (BACKGROUND). Finally, should you completely exit the app by hitting the back button from the home page, you may still receive a notification. Touching that notification in the notification tray will relaunch your app and allow you to process the notification (COLDSTART). In this case the **coldstart** flag will be set on the incoming event. You can look at the **foreground** flag on the event to determine whether you are processing a background or an in-line notification. You may choose, for example to play a sound or show a dialog only for inline or coldstart notifications since the user has already been alerted via the status bar. + +Also make note of the **payload** object. Since the Android notification data model is much more flexible than that of iOS, there may be additional elements beyond **message**, **soundname**, and **msgcnt**. You can access those elements and any additional ones via the **payload** element. This means that if your data model should change in the future, there will be no need to change and recompile the plugin. + +##### wp8 +Register as + +```js +pushNotification = window.plugins.pushNotification; +pushNotification.register(successHandler, errorHandler, {"channelName":"your_channel_name","ecb":"onNotification"}); + +function successHandler(result) { + console.log('registered###' + result.uri); + // send uri to your notification server +} +``` + +onNotification is fired if the app is running when you receive the toast notification + +```js +function onNotification (e) { + navigator.notification.alert(e.text2, function(){}, e.text1); +} +``` + +When not using PhoneGap Build, you can control the launch page when the user taps on your toast notification when the app is not running. Add the following code to your MainPage.xaml.cs: + +``` + protected override void OnNavigatedTo(System.Windows.Navigation.NavigationEventArgs e) + { + base.OnNavigatedTo(e); + try + { + if (this.NavigationContext.QueryString["NavigatedFrom"] == "toast") // this is set on the server + { + this.CordovaView.StartPageUri = new Uri("//www/index.html#notification-page", UriKind.Relative); + } + } + catch (KeyNotFoundException) + { + } + } +``` + +#### unregister +You will typically call this when your app is exiting, to cleanup any used resources. Its not strictly necessary to call it, and indeed it may be desireable to NOT call it if you are debugging your intermediarry push server. When you call unregister(), the current token for a particular device will get invalidated, and the next call to register() will return a new token. If you do NOT call unregister(), the last token will remain in effect until it is invalidated for some reason at the GCM side. Since such invalidations are beyond your control, its recommended that, in a production environment, that you have a matching unregister() call, for every call to register(), and that your server updates the devices' records each time. + +```js +pushNotification.unregister(successHandler, errorHandler); +``` + +You'll probably want to trap on the **backbutton** event and only call this when the home page is showing. Remember, the back button on android is not the same as the Home button. When you hit the back button from the home page, your activity gets dismissed. Here is an example of how to trap the backbutton event; + +```js +function onDeviceReady() { + $("#app-status-ul").append('
  • deviceready event received
  • '); + + document.addEventListener("backbutton", function(e) + { + $("#app-status-ul").append('
  • backbutton event received
  • '); - // Android - function onNotificationGCM(e) { - switch( e.event ) + if( $("#home").length > 0 ) { - case 'registered': - if ( e.regid.length > 0 ) - { - // Your GCM push server needs to know the regID before it can push to this device - // here is where you might want to send it the regID for later use. - alert('registration id = e.regid); - } - break; - - case 'message': - // this is the actual push notification. its format depends on the data model - // of the intermediary push server which must also be reflected in GCMIntentService.java - alert('message = '+e.message+' msgcnt = '+e.msgcnt); - break; - - case 'error': - alert('GCM error = e.msg); - break; - - default: - alert('An unknown GCM event has occurred); - break; + e.preventDefault(); + pushNotification.unregister(successHandler, errorHandler); + navigator.app.exitApp(); } - } - -#### unregister -Call this when your app is exiting to cleanup any used resources. + else + { + navigator.app.backHistory(); + } + }, false); + + // aditional onDeviceReady work… +} +``` + +For the above to work, make sure the content for your home page is wrapped in an element with an id of home, like this; + +```html +
    +
    +
      +
    • Cordova PushNotification Plugin Demo
    • +
    +
    +
    +``` - pushNotification.unregister(successHandler, errorHandler); - #### setApplicationIconBadgeNumber (iOS only) set the badge count visible when the app is not running - - pushNotification.setApplicationIconBadgeNumber(successCallback, badgeCount); + +```js +pushNotification.setApplicationIconBadgeNumber(successCallback, errorCallback, badgeCount); +``` **badgeCount** - an integer indicating what number should show up in the badge. Passing 0 will clear the badge. @@ -213,7 +430,7 @@ The notification system consists of several interdependent components. 1) The client application which runs on a device and receives notifications. 2) The notification service provider (APNS for Apple, GCM for Google) 3) Intermediary servers that collect device IDs from clients and push notifications through APNS and/or GCM. - + This plugin and its target Cordova application comprise the client application.The APNS and GCM infrastructure are maintained by Apple and Google, respectively. In order to send push notifications to your users, you would typically run an intermediary server or employ a 3rd party push service. This is true for both GCM (Android) and APNS (iOS) notifications. However, when testing the notification client applications, it may be desirable to be able to push notifications directly from your desktop, without having to design and build those server's first. There are a number of solutions out there to allow you to push from a desktop machine, sans server. The easiest I've found to work with is a ruby gem called [pushmeup](http://rubygems.org/gems/pushmeup). I've only tried this on Mac, but it probably works fine on Windows as well. Here's a rough outline; **Prerequisites**. @@ -223,26 +440,24 @@ This plugin and its target Cordova application comprise the client application.T - You have successfully built a client with this plugin, on both iOS and Android and have installed them on a device. -#### 1) [Get the gem](https://github.com/NicosKaralis/pushmeup), either by downloading the zip or cloning the repo. - - a) cd to the pushmeup directory you just downloaded - b) sudo gem install pushmeup - +#### 1) [Get the gem](https://github.com/NicosKaralis/pushmeup) + $ sudo gem install pushmeup + #### 2) (iOS) [Follow this tutorial](http://www.raywenderlich.com/3443/apple-push-notification-services-tutorial-part-12) to create a file called ck.pem. Start at the section entitled "Generating the Certificate Signing Request (CSR)", and substitute your own Bundle Identifier, and Description. - - a) go the this plugin's Example folder and open pushAPNS.rb in the text editor of your choice. + + a) go the this plugin's Example/server folder and open pushAPNS.rb in the text editor of your choice. b) set the APNS.pem variable to the path of the ck.pem file you just created c) set APNS.pass to the password associated with the certificate you just created. (warning this is cleartext, so don't share this file) d) set device_token to the token for the device you want to send a push to. (you can run the Cordova app / plugin in Xcode and extract the token from the log messages) e) save your changes. - + #### 3) (Android) [Follow these steps](http://developer.android.com/guide/google/gcm/gs.html) to generate a project ID and a server based API key. - a) go the this plugin's Example folder and open pushGCM.rb in the text editor of your choice. + a) go the this plugin's Example/server folder and open pushGCM.rb in the text editor of your choice. b) set the GCM.key variable to the API key you just generated. c) set the destination variable to the Registration ID of the device. (you can run the Cordova app / plugin in on a device via Eclipse and extract the regID from the log messages) - + #### 4) Push a notification a) cd to the directory containing the two .rb files we just edited. @@ -271,7 +486,7 @@ If you run this demo using the emulator you will not receive notifications from If everything seems right and you are not receiving a registration id response back from Google, try uninstalling and reinstalling your app. That has worked for some devs out there. -While the data model for iOS is somewhat fixed, it should be noted that GCM is far more flexible. The Android implementation in this plugin, for example, assumes the incoming message will contain a 'message' and a 'msgcnt' node. This is reflected in both the plugin (see GCMIntentService.java) as well as in provided example ruby script (pushGCM.rb). Should you employ a commercial service, their data model may differ, in which case the plugin will need to me modified to accommodate those differences. +While the data model for iOS is somewhat fixed, it should be noted that GCM is far more flexible. The Android implementation in this plugin, for example, assumes the incoming message will contain a '**message**' and a '**msgcnt**' node. This is reflected in both the plugin (see GCMIntentService.java) as well as in provided example ruby script (pushGCM.rb). Should you employ a commercial service, their data model may differ. As mentioned earlier, this is where you will want to take a look at the **payload** element of the message event. In addition to the cannonical message and msgcnt elements, any additional elements in the incoming JSON object will be accessible here, obviating the need to edit and recompile the plugin. Many thanks to Tobias Hößl for this functionality! ## Additional Resources @@ -290,3 +505,5 @@ While the data model for iOS is somewhat fixed, it should be noted that GCM is f Huge thanks to Mark Nutter whose [GCM-Cordova plugin](https://github.com/marknutter/GCM-Cordova) forms the basis for the Android side implimentation. Likewise, the iOS side was inspired by Olivier Louvignes' [Cordova PushNotification Plugin](https://github.com/phonegap/phonegap-plugins/tree/master/iOS/PushNotification) (Copyright (c) 2012 Olivier Louvignes) for iOS. + +Props to [Tobias Hößl](https://github.com/CatoTH), who provided the code to surface the full JSON object up to the JS layer. diff --git a/plugin.xml b/plugin.xml index f19648f8..61873231 100755 --- a/plugin.xml +++ b/plugin.xml @@ -1,51 +1,101 @@ - PushPlugin + id="com.phonegap.plugins.PushPlugin" + version="2.2.0"> - + PushPlugin + Bob Easterday + + This plugin allows your application to receive push notifications on Android, iOS and WP8 devices. + Android uses Google Cloud Messaging. + iOS uses Apple APNS Notifications. + WP8 uses Microsoft MPNS Notifications. + + + MIT + + + + + + + + + + - - - - + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/spec/genericpush.tests.js b/spec/genericpush.tests.js new file mode 100644 index 00000000..7374ba4e --- /dev/null +++ b/spec/genericpush.tests.js @@ -0,0 +1,46 @@ +/* + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * +*/ + +describe('Plugin object (window.plugins)', function () { + it("should exist", function() { + expect(window.plugins).toBeDefined(); + }); + + it("should contain a pushNotification object", function() { + expect(window.plugins.pushNotification).toBeDefined(); + expect(typeof window.plugins.pushNotification == 'object').toBe(true); + }); + + it("should contain a register function", function() { + expect(window.plugins.pushNotification.register).toBeDefined(); + expect(typeof window.plugins.pushNotification.register == 'function').toBe(true); + }); + + it("should contain an unregister function", function() { + expect(window.plugins.pushNotification.unregister).toBeDefined(); + expect(typeof window.plugins.pushNotification.unregister == 'function').toBe(true); + }); + + it("should contain a setApplicationIconBadgeNumber function", function() { + expect(window.plugins.pushNotification.setApplicationIconBadgeNumber).toBeDefined(); + expect(typeof window.plugins.pushNotification.setApplicationIconBadgeNumber == 'function').toBe(true); + }); +}); diff --git a/spec/html/HtmlReporter.js b/spec/html/HtmlReporter.js new file mode 100644 index 00000000..7d9d9240 --- /dev/null +++ b/spec/html/HtmlReporter.js @@ -0,0 +1,101 @@ +jasmine.HtmlReporter = function(_doc) { + var self = this; + var doc = _doc || window.document; + + var reporterView; + + var dom = {}; + + // Jasmine Reporter Public Interface + self.logRunningSpecs = false; + + self.reportRunnerStarting = function(runner) { + var specs = runner.specs() || []; + + if (specs.length == 0) { + return; + } + + createReporterDom(runner.env.versionString()); + doc.body.appendChild(dom.reporter); + + reporterView = new jasmine.HtmlReporter.ReporterView(dom); + reporterView.addSpecs(specs, self.specFilter); + }; + + self.reportRunnerResults = function(runner) { + reporterView && reporterView.complete(); + }; + + self.reportSuiteResults = function(suite) { + reporterView.suiteComplete(suite); + }; + + self.reportSpecStarting = function(spec) { + if (self.logRunningSpecs) { + self.log('>> Jasmine Running ' + spec.suite.description + ' ' + spec.description + '...'); + } + }; + + self.reportSpecResults = function(spec) { + reporterView.specComplete(spec); + }; + + self.log = function() { + var console = jasmine.getGlobal().console; + if (console && console.log) { + if (console.log.apply) { + console.log.apply(console, arguments); + } else { + console.log(arguments); // ie fix: console.log.apply doesn't exist on ie + } + } + }; + + self.specFilter = function(spec) { + if (!focusedSpecName()) { + return true; + } + + return spec.getFullName().indexOf(focusedSpecName()) === 0; + }; + + return self; + + function focusedSpecName() { + var specName; + + (function memoizeFocusedSpec() { + if (specName) { + return; + } + + var paramMap = []; + var params = doc.location.search.substring(1).split('&'); + + for (var i = 0; i < params.length; i++) { + var p = params[i].split('='); + paramMap[decodeURIComponent(p[0])] = decodeURIComponent(p[1]); + } + + specName = paramMap.spec; + })(); + + return specName; + } + + function createReporterDom(version) { + dom.reporter = self.createDom('div', { id: 'HTMLReporter', className: 'jasmine_reporter' }, + dom.banner = self.createDom('div', { className: 'banner' }, + self.createDom('span', { className: 'title' }, "Jasmine "), + self.createDom('span', { className: 'version' }, version)), + + dom.symbolSummary = self.createDom('ul', {className: 'symbolSummary'}), + dom.alert = self.createDom('div', {className: 'alert'}), + dom.results = self.createDom('div', {className: 'results'}, + dom.summary = self.createDom('div', { className: 'summary' }), + dom.details = self.createDom('div', { id: 'details' })) + ); + } +}; +jasmine.HtmlReporterHelpers.addHelpers(jasmine.HtmlReporter); diff --git a/spec/html/HtmlReporterHelpers.js b/spec/html/HtmlReporterHelpers.js new file mode 100644 index 00000000..745e1e09 --- /dev/null +++ b/spec/html/HtmlReporterHelpers.js @@ -0,0 +1,60 @@ +jasmine.HtmlReporterHelpers = {}; + +jasmine.HtmlReporterHelpers.createDom = function(type, attrs, childrenVarArgs) { + var el = document.createElement(type); + + for (var i = 2; i < arguments.length; i++) { + var child = arguments[i]; + + if (typeof child === 'string') { + el.appendChild(document.createTextNode(child)); + } else { + if (child) { + el.appendChild(child); + } + } + } + + for (var attr in attrs) { + if (attr == "className") { + el[attr] = attrs[attr]; + } else { + el.setAttribute(attr, attrs[attr]); + } + } + + return el; +}; + +jasmine.HtmlReporterHelpers.getSpecStatus = function(child) { + var results = child.results(); + var status = results.passed() ? 'passed' : 'failed'; + if (results.skipped) { + status = 'skipped'; + } + + return status; +}; + +jasmine.HtmlReporterHelpers.appendToSummary = function(child, childElement) { + var parentDiv = this.dom.summary; + var parentSuite = (typeof child.parentSuite == 'undefined') ? 'suite' : 'parentSuite'; + var parent = child[parentSuite]; + + if (parent) { + if (typeof this.views.suites[parent.id] == 'undefined') { + this.views.suites[parent.id] = new jasmine.HtmlReporter.SuiteView(parent, this.dom, this.views); + } + parentDiv = this.views.suites[parent.id].element; + } + + parentDiv.appendChild(childElement); +}; + + +jasmine.HtmlReporterHelpers.addHelpers = function(ctor) { + for(var fn in jasmine.HtmlReporterHelpers) { + ctor.prototype[fn] = jasmine.HtmlReporterHelpers[fn]; + } +}; + diff --git a/spec/html/ReporterView.js b/spec/html/ReporterView.js new file mode 100644 index 00000000..6a6d0056 --- /dev/null +++ b/spec/html/ReporterView.js @@ -0,0 +1,164 @@ +jasmine.HtmlReporter.ReporterView = function(dom) { + this.startedAt = new Date(); + this.runningSpecCount = 0; + this.completeSpecCount = 0; + this.passedCount = 0; + this.failedCount = 0; + this.skippedCount = 0; + + this.createResultsMenu = function() { + this.resultsMenu = this.createDom('span', {className: 'resultsMenu bar'}, + this.summaryMenuItem = this.createDom('a', {className: 'summaryMenuItem', href: "#"}, '0 specs'), + ' | ', + this.detailsMenuItem = this.createDom('a', {className: 'detailsMenuItem', href: "#"}, '0 failing')); + + this.summaryMenuItem.onclick = function() { + dom.reporter.className = dom.reporter.className.replace(/ showDetails/g, ''); + }; + + this.detailsMenuItem.onclick = function() { + showDetails(); + }; + }; + + this.addSpecs = function(specs, specFilter) { + this.totalSpecCount = specs.length; + + this.views = { + specs: {}, + suites: {} + }; + + for (var i = 0; i < specs.length; i++) { + var spec = specs[i]; + this.views.specs[spec.id] = new jasmine.HtmlReporter.SpecView(spec, dom, this.views); + if (specFilter(spec)) { + this.runningSpecCount++; + } + } + }; + + this.specComplete = function(spec) { + this.completeSpecCount++; + + if (isUndefined(this.views.specs[spec.id])) { + this.views.specs[spec.id] = new jasmine.HtmlReporter.SpecView(spec, dom); + } + + var specView = this.views.specs[spec.id]; + + switch (specView.status()) { + case 'passed': + this.passedCount++; + break; + + case 'failed': + this.failedCount++; + break; + + case 'skipped': + this.skippedCount++; + break; + } + + specView.refresh(); + this.refresh(); + }; + + this.suiteComplete = function(suite) { + var suiteView = this.views.suites[suite.id]; + if (isUndefined(suiteView)) { + return; + } + suiteView.refresh(); + }; + + this.refresh = function() { + + if (isUndefined(this.resultsMenu)) { + this.createResultsMenu(); + } + + // currently running UI + if (isUndefined(this.runningAlert)) { + this.runningAlert = this.createDom('a', {href: "?", className: "runningAlert bar"}); + dom.alert.appendChild(this.runningAlert); + } + this.runningAlert.innerHTML = "Running " + this.completeSpecCount + " of " + specPluralizedFor(this.totalSpecCount); + + // skipped specs UI + if (isUndefined(this.skippedAlert)) { + this.skippedAlert = this.createDom('a', {href: "?", className: "skippedAlert bar"}); + } + + this.skippedAlert.innerHTML = "Skipping " + this.skippedCount + " of " + specPluralizedFor(this.totalSpecCount) + " - run all"; + + if (this.skippedCount === 1 && isDefined(dom.alert)) { + dom.alert.appendChild(this.skippedAlert); + } + + // passing specs UI + if (isUndefined(this.passedAlert)) { + this.passedAlert = this.createDom('span', {href: "?", className: "passingAlert bar"}); + } + this.passedAlert.innerHTML = "Passing " + specPluralizedFor(this.passedCount); + + // failing specs UI + if (isUndefined(this.failedAlert)) { + this.failedAlert = this.createDom('span', {href: "?", className: "failingAlert bar"}); + } + this.failedAlert.innerHTML = "Failing " + specPluralizedFor(this.failedCount); + + if (this.failedCount === 1 && isDefined(dom.alert)) { + dom.alert.appendChild(this.failedAlert); + dom.alert.appendChild(this.resultsMenu); + } + + // summary info + this.summaryMenuItem.innerHTML = "" + specPluralizedFor(this.runningSpecCount); + this.detailsMenuItem.innerHTML = "" + this.failedCount + " failing"; + }; + + this.complete = function() { + dom.alert.removeChild(this.runningAlert); + + this.skippedAlert.innerHTML = "Ran " + this.runningSpecCount + " of " + specPluralizedFor(this.totalSpecCount) + " - run all"; + + if (this.failedCount === 0) { + dom.alert.appendChild(this.createDom('span', {className: 'passingAlert bar'}, "Passing " + specPluralizedFor(this.passedCount))); + } else { + showDetails(); + } + + dom.banner.appendChild(this.createDom('span', {className: 'duration'}, "finished in " + ((new Date().getTime() - this.startedAt.getTime()) / 1000) + "s")); + }; + + return this; + + function showDetails() { + if (dom.reporter.className.search(/showDetails/) === -1) { + dom.reporter.className += " showDetails"; + } + } + + function isUndefined(obj) { + return typeof obj === 'undefined'; + } + + function isDefined(obj) { + return !isUndefined(obj); + } + + function specPluralizedFor(count) { + var str = count + " spec"; + if (count > 1) { + str += "s" + } + return str; + } + +}; + +jasmine.HtmlReporterHelpers.addHelpers(jasmine.HtmlReporter.ReporterView); + + diff --git a/spec/html/SpecView.js b/spec/html/SpecView.js new file mode 100644 index 00000000..8769bb84 --- /dev/null +++ b/spec/html/SpecView.js @@ -0,0 +1,79 @@ +jasmine.HtmlReporter.SpecView = function(spec, dom, views) { + this.spec = spec; + this.dom = dom; + this.views = views; + + this.symbol = this.createDom('li', { className: 'pending' }); + this.dom.symbolSummary.appendChild(this.symbol); + + this.summary = this.createDom('div', { className: 'specSummary' }, + this.createDom('a', { + className: 'description', + href: '?spec=' + encodeURIComponent(this.spec.getFullName()), + title: this.spec.getFullName() + }, this.spec.description) + ); + + this.detail = this.createDom('div', { className: 'specDetail' }, + this.createDom('a', { + className: 'description', + href: '?spec=' + encodeURIComponent(this.spec.getFullName()), + title: this.spec.getFullName() + }, this.spec.getFullName()) + ); +}; + +jasmine.HtmlReporter.SpecView.prototype.status = function() { + return this.getSpecStatus(this.spec); +}; + +jasmine.HtmlReporter.SpecView.prototype.refresh = function() { + this.symbol.className = this.status(); + + switch (this.status()) { + case 'skipped': + break; + + case 'passed': + this.appendSummaryToSuiteDiv(); + break; + + case 'failed': + this.appendSummaryToSuiteDiv(); + this.appendFailureDetail(); + break; + } +}; + +jasmine.HtmlReporter.SpecView.prototype.appendSummaryToSuiteDiv = function() { + this.summary.className += ' ' + this.status(); + this.appendToSummary(this.spec, this.summary); +}; + +jasmine.HtmlReporter.SpecView.prototype.appendFailureDetail = function() { + this.detail.className += ' ' + this.status(); + + var resultItems = this.spec.results().getItems(); + var messagesDiv = this.createDom('div', { className: 'messages' }); + + for (var i = 0; i < resultItems.length; i++) { + var result = resultItems[i]; + + if (result.type == 'log') { + messagesDiv.appendChild(this.createDom('div', {className: 'resultMessage log'}, result.toString())); + } else if (result.type == 'expect' && result.passed && !result.passed()) { + messagesDiv.appendChild(this.createDom('div', {className: 'resultMessage fail'}, result.message)); + + if (result.trace.stack) { + messagesDiv.appendChild(this.createDom('div', {className: 'stackTrace'}, result.trace.stack)); + } + } + } + + if (messagesDiv.childNodes.length > 0) { + this.detail.appendChild(messagesDiv); + this.dom.details.appendChild(this.detail); + } +}; + +jasmine.HtmlReporterHelpers.addHelpers(jasmine.HtmlReporter.SpecView); \ No newline at end of file diff --git a/spec/html/SuiteView.js b/spec/html/SuiteView.js new file mode 100644 index 00000000..19a1efaf --- /dev/null +++ b/spec/html/SuiteView.js @@ -0,0 +1,22 @@ +jasmine.HtmlReporter.SuiteView = function(suite, dom, views) { + this.suite = suite; + this.dom = dom; + this.views = views; + + this.element = this.createDom('div', { className: 'suite' }, + this.createDom('a', { className: 'description', href: '?spec=' + encodeURIComponent(this.suite.getFullName()) }, this.suite.description) + ); + + this.appendToSummary(this.suite, this.element); +}; + +jasmine.HtmlReporter.SuiteView.prototype.status = function() { + return this.getSpecStatus(this.suite); +}; + +jasmine.HtmlReporter.SuiteView.prototype.refresh = function() { + this.element.className += " " + this.status(); +}; + +jasmine.HtmlReporterHelpers.addHelpers(jasmine.HtmlReporter.SuiteView); + diff --git a/spec/html/TrivialReporter.js b/spec/html/TrivialReporter.js new file mode 100644 index 00000000..167ac506 --- /dev/null +++ b/spec/html/TrivialReporter.js @@ -0,0 +1,192 @@ +/* @deprecated Use jasmine.HtmlReporter instead + */ +jasmine.TrivialReporter = function(doc) { + this.document = doc || document; + this.suiteDivs = {}; + this.logRunningSpecs = false; +}; + +jasmine.TrivialReporter.prototype.createDom = function(type, attrs, childrenVarArgs) { + var el = document.createElement(type); + + for (var i = 2; i < arguments.length; i++) { + var child = arguments[i]; + + if (typeof child === 'string') { + el.appendChild(document.createTextNode(child)); + } else { + if (child) { el.appendChild(child); } + } + } + + for (var attr in attrs) { + if (attr == "className") { + el[attr] = attrs[attr]; + } else { + el.setAttribute(attr, attrs[attr]); + } + } + + return el; +}; + +jasmine.TrivialReporter.prototype.reportRunnerStarting = function(runner) { + var showPassed, showSkipped; + + this.outerDiv = this.createDom('div', { id: 'TrivialReporter', className: 'jasmine_reporter' }, + this.createDom('div', { className: 'banner' }, + this.createDom('div', { className: 'logo' }, + this.createDom('span', { className: 'title' }, "Jasmine"), + this.createDom('span', { className: 'version' }, runner.env.versionString())), + this.createDom('div', { className: 'options' }, + "Show ", + showPassed = this.createDom('input', { id: "__jasmine_TrivialReporter_showPassed__", type: 'checkbox' }), + this.createDom('label', { "for": "__jasmine_TrivialReporter_showPassed__" }, " passed "), + showSkipped = this.createDom('input', { id: "__jasmine_TrivialReporter_showSkipped__", type: 'checkbox' }), + this.createDom('label', { "for": "__jasmine_TrivialReporter_showSkipped__" }, " skipped") + ) + ), + + this.runnerDiv = this.createDom('div', { className: 'runner running' }, + this.createDom('a', { className: 'run_spec', href: '?' }, "run all"), + this.runnerMessageSpan = this.createDom('span', {}, "Running..."), + this.finishedAtSpan = this.createDom('span', { className: 'finished-at' }, "")) + ); + + this.document.body.appendChild(this.outerDiv); + + var suites = runner.suites(); + for (var i = 0; i < suites.length; i++) { + var suite = suites[i]; + var suiteDiv = this.createDom('div', { className: 'suite' }, + this.createDom('a', { className: 'run_spec', href: '?spec=' + encodeURIComponent(suite.getFullName()) }, "run"), + this.createDom('a', { className: 'description', href: '?spec=' + encodeURIComponent(suite.getFullName()) }, suite.description)); + this.suiteDivs[suite.id] = suiteDiv; + var parentDiv = this.outerDiv; + if (suite.parentSuite) { + parentDiv = this.suiteDivs[suite.parentSuite.id]; + } + parentDiv.appendChild(suiteDiv); + } + + this.startedAt = new Date(); + + var self = this; + showPassed.onclick = function(evt) { + if (showPassed.checked) { + self.outerDiv.className += ' show-passed'; + } else { + self.outerDiv.className = self.outerDiv.className.replace(/ show-passed/, ''); + } + }; + + showSkipped.onclick = function(evt) { + if (showSkipped.checked) { + self.outerDiv.className += ' show-skipped'; + } else { + self.outerDiv.className = self.outerDiv.className.replace(/ show-skipped/, ''); + } + }; +}; + +jasmine.TrivialReporter.prototype.reportRunnerResults = function(runner) { + var results = runner.results(); + var className = (results.failedCount > 0) ? "runner failed" : "runner passed"; + this.runnerDiv.setAttribute("class", className); + //do it twice for IE + this.runnerDiv.setAttribute("className", className); + var specs = runner.specs(); + var specCount = 0; + for (var i = 0; i < specs.length; i++) { + if (this.specFilter(specs[i])) { + specCount++; + } + } + var message = "" + specCount + " spec" + (specCount == 1 ? "" : "s" ) + ", " + results.failedCount + " failure" + ((results.failedCount == 1) ? "" : "s"); + message += " in " + ((new Date().getTime() - this.startedAt.getTime()) / 1000) + "s"; + this.runnerMessageSpan.replaceChild(this.createDom('a', { className: 'description', href: '?'}, message), this.runnerMessageSpan.firstChild); + + this.finishedAtSpan.appendChild(document.createTextNode("Finished at " + new Date().toString())); +}; + +jasmine.TrivialReporter.prototype.reportSuiteResults = function(suite) { + var results = suite.results(); + var status = results.passed() ? 'passed' : 'failed'; + if (results.totalCount === 0) { // todo: change this to check results.skipped + status = 'skipped'; + } + this.suiteDivs[suite.id].className += " " + status; +}; + +jasmine.TrivialReporter.prototype.reportSpecStarting = function(spec) { + if (this.logRunningSpecs) { + this.log('>> Jasmine Running ' + spec.suite.description + ' ' + spec.description + '...'); + } +}; + +jasmine.TrivialReporter.prototype.reportSpecResults = function(spec) { + var results = spec.results(); + var status = results.passed() ? 'passed' : 'failed'; + if (results.skipped) { + status = 'skipped'; + } + var specDiv = this.createDom('div', { className: 'spec ' + status }, + this.createDom('a', { className: 'run_spec', href: '?spec=' + encodeURIComponent(spec.getFullName()) }, "run"), + this.createDom('a', { + className: 'description', + href: '?spec=' + encodeURIComponent(spec.getFullName()), + title: spec.getFullName() + }, spec.description)); + + + var resultItems = results.getItems(); + var messagesDiv = this.createDom('div', { className: 'messages' }); + for (var i = 0; i < resultItems.length; i++) { + var result = resultItems[i]; + + if (result.type == 'log') { + messagesDiv.appendChild(this.createDom('div', {className: 'resultMessage log'}, result.toString())); + } else if (result.type == 'expect' && result.passed && !result.passed()) { + messagesDiv.appendChild(this.createDom('div', {className: 'resultMessage fail'}, result.message)); + + if (result.trace.stack) { + messagesDiv.appendChild(this.createDom('div', {className: 'stackTrace'}, result.trace.stack)); + } + } + } + + if (messagesDiv.childNodes.length > 0) { + specDiv.appendChild(messagesDiv); + } + + this.suiteDivs[spec.suite.id].appendChild(specDiv); +}; + +jasmine.TrivialReporter.prototype.log = function() { + var console = jasmine.getGlobal().console; + if (console && console.log) { + if (console.log.apply) { + console.log.apply(console, arguments); + } else { + console.log(arguments); // ie fix: console.log.apply doesn't exist on ie + } + } +}; + +jasmine.TrivialReporter.prototype.getLocation = function() { + return this.document.location; +}; + +jasmine.TrivialReporter.prototype.specFilter = function(spec) { + var paramMap = {}; + var params = this.getLocation().search.substring(1).split('&'); + for (var i = 0; i < params.length; i++) { + var p = params[i].split('='); + paramMap[decodeURIComponent(p[0])] = decodeURIComponent(p[1]); + } + + if (!paramMap.spec) { + return true; + } + return spec.getFullName().indexOf(paramMap.spec) === 0; +}; diff --git a/spec/index.html b/spec/index.html new file mode 100644 index 00000000..81655f36 --- /dev/null +++ b/spec/index.html @@ -0,0 +1,75 @@ + + + + + + + Cordova: API Specs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Back + + diff --git a/spec/jasmine.css b/spec/jasmine.css new file mode 100644 index 00000000..826e5753 --- /dev/null +++ b/spec/jasmine.css @@ -0,0 +1,81 @@ +body { background-color: #eeeeee; padding: 0; margin: 5px; overflow-y: scroll; } + +#HTMLReporter { font-size: 11px; font-family: Monaco, "Lucida Console", monospace; line-height: 14px; color: #333333; } +#HTMLReporter a { text-decoration: none; } +#HTMLReporter a:hover { text-decoration: underline; } +#HTMLReporter p, #HTMLReporter h1, #HTMLReporter h2, #HTMLReporter h3, #HTMLReporter h4, #HTMLReporter h5, #HTMLReporter h6 { margin: 0; line-height: 14px; } +#HTMLReporter .banner, #HTMLReporter .symbolSummary, #HTMLReporter .summary, #HTMLReporter .resultMessage, #HTMLReporter .specDetail .description, #HTMLReporter .alert .bar, #HTMLReporter .stackTrace { padding-left: 9px; padding-right: 9px; } +#HTMLReporter #jasmine_content { position: fixed; right: 100%; } +#HTMLReporter .version { color: #aaaaaa; } +#HTMLReporter .banner { margin-top: 14px; } +#HTMLReporter .duration { color: #aaaaaa; float: right; } +#HTMLReporter .symbolSummary { overflow: hidden; *zoom: 1; margin: 14px 0; } +#HTMLReporter .symbolSummary li { display: block; float: left; height: 7px; width: 14px; margin-bottom: 7px; font-size: 16px; } +#HTMLReporter .symbolSummary li.passed { font-size: 14px; } +#HTMLReporter .symbolSummary li.passed:before { color: #5e7d00; content: "\02022"; } +#HTMLReporter .symbolSummary li.failed { line-height: 9px; } +#HTMLReporter .symbolSummary li.failed:before { color: #b03911; content: "x"; font-weight: bold; margin-left: -1px; } +#HTMLReporter .symbolSummary li.skipped { font-size: 14px; } +#HTMLReporter .symbolSummary li.skipped:before { color: #bababa; content: "\02022"; } +#HTMLReporter .symbolSummary li.pending { line-height: 11px; } +#HTMLReporter .symbolSummary li.pending:before { color: #aaaaaa; content: "-"; } +#HTMLReporter .bar { line-height: 28px; font-size: 14px; display: block; color: #eee; } +#HTMLReporter .runningAlert { background-color: #666666; } +#HTMLReporter .skippedAlert { background-color: #aaaaaa; } +#HTMLReporter .skippedAlert:first-child { background-color: #333333; } +#HTMLReporter .skippedAlert:hover { text-decoration: none; color: white; text-decoration: underline; } +#HTMLReporter .passingAlert { background-color: #a6b779; } +#HTMLReporter .passingAlert:first-child { background-color: #5e7d00; } +#HTMLReporter .failingAlert { background-color: #cf867e; } +#HTMLReporter .failingAlert:first-child { background-color: #b03911; } +#HTMLReporter .results { margin-top: 14px; } +#HTMLReporter #details { display: none; } +#HTMLReporter .resultsMenu, #HTMLReporter .resultsMenu a { background-color: #fff; color: #333333; } +#HTMLReporter.showDetails .summaryMenuItem { font-weight: normal; text-decoration: inherit; } +#HTMLReporter.showDetails .summaryMenuItem:hover { text-decoration: underline; } +#HTMLReporter.showDetails .detailsMenuItem { font-weight: bold; text-decoration: underline; } +#HTMLReporter.showDetails .summary { display: none; } +#HTMLReporter.showDetails #details { display: block; } +#HTMLReporter .summaryMenuItem { font-weight: bold; text-decoration: underline; } +#HTMLReporter .summary { margin-top: 14px; } +#HTMLReporter .summary .suite .suite, #HTMLReporter .summary .specSummary { margin-left: 14px; } +#HTMLReporter .summary .specSummary.passed a { color: #5e7d00; } +#HTMLReporter .summary .specSummary.failed a { color: #b03911; } +#HTMLReporter .description + .suite { margin-top: 0; } +#HTMLReporter .suite { margin-top: 14px; } +#HTMLReporter .suite a { color: #333333; } +#HTMLReporter #details .specDetail { margin-bottom: 28px; } +#HTMLReporter #details .specDetail .description { display: block; color: white; background-color: #b03911; } +#HTMLReporter .resultMessage { padding-top: 14px; color: #333333; } +#HTMLReporter .resultMessage span.result { display: block; } +#HTMLReporter .stackTrace { margin: 5px 0 0 0; max-height: 224px; overflow: auto; line-height: 18px; color: #666666; border: 1px solid #ddd; background: white; white-space: pre; } + +#TrivialReporter { padding: 8px 13px; position: absolute; top: 0; bottom: 0; left: 0; right: 0; overflow-y: scroll; background-color: white; font-family: "Helvetica Neue Light", "Lucida Grande", "Calibri", "Arial", sans-serif; /*.resultMessage {*/ /*white-space: pre;*/ /*}*/ } +#TrivialReporter a:visited, #TrivialReporter a { color: #303; } +#TrivialReporter a:hover, #TrivialReporter a:active { color: blue; } +#TrivialReporter .run_spec { float: right; padding-right: 5px; font-size: .8em; text-decoration: none; } +#TrivialReporter .banner { color: #303; background-color: #fef; padding: 5px; } +#TrivialReporter .logo { float: left; font-size: 1.1em; padding-left: 5px; } +#TrivialReporter .logo .version { font-size: .6em; padding-left: 1em; } +#TrivialReporter .runner.running { background-color: yellow; } +#TrivialReporter .options { text-align: right; font-size: .8em; } +#TrivialReporter .suite { border: 1px outset gray; margin: 5px 0; padding-left: 1em; } +#TrivialReporter .suite .suite { margin: 5px; } +#TrivialReporter .suite.passed { background-color: #dfd; } +#TrivialReporter .suite.failed { background-color: #fdd; } +#TrivialReporter .spec { margin: 5px; padding-left: 1em; clear: both; } +#TrivialReporter .spec.failed, #TrivialReporter .spec.passed, #TrivialReporter .spec.skipped { padding-bottom: 5px; border: 1px solid gray; } +#TrivialReporter .spec.failed { background-color: #fbb; border-color: red; } +#TrivialReporter .spec.passed { background-color: #bfb; border-color: green; } +#TrivialReporter .spec.skipped { background-color: #bbb; } +#TrivialReporter .messages { border-left: 1px dashed gray; padding-left: 1em; padding-right: 1em; } +#TrivialReporter .passed { background-color: #cfc; display: none; } +#TrivialReporter .failed { background-color: #fbb; } +#TrivialReporter .skipped { color: #777; background-color: #eee; display: none; } +#TrivialReporter .resultMessage span.result { display: block; line-height: 2em; color: black; } +#TrivialReporter .resultMessage .mismatch { color: black; } +#TrivialReporter .stackTrace { white-space: pre; font-size: .8em; margin-left: 10px; max-height: 5em; overflow: auto; border: 1px inset red; padding: 1em; background: #eef; } +#TrivialReporter .finished-at { padding-left: 1em; font-size: .6em; } +#TrivialReporter.show-passed .passed, #TrivialReporter.show-skipped .skipped { display: block; } +#TrivialReporter #jasmine_content { position: fixed; right: 100%; } +#TrivialReporter .runner { border: 1px solid gray; display: block; margin: 5px 0; padding: 2px 0 2px 10px; } diff --git a/spec/jasmine.js b/spec/jasmine.js new file mode 100644 index 00000000..bccb66c3 --- /dev/null +++ b/spec/jasmine.js @@ -0,0 +1,2530 @@ +var isCommonJS = typeof window == "undefined"; + +/** + * Top level namespace for Jasmine, a lightweight JavaScript BDD/spec/testing framework. + * + * @namespace + */ +var jasmine = {}; +if (isCommonJS) exports.jasmine = jasmine; +/** + * @private + */ +jasmine.unimplementedMethod_ = function() { + throw new Error("unimplemented method"); +}; + +/** + * Use jasmine.undefined instead of undefined, since undefined is just + * a plain old variable and may be redefined by somebody else. + * + * @private + */ +jasmine.undefined = jasmine.___undefined___; + +/** + * Show diagnostic messages in the console if set to true + * + */ +jasmine.VERBOSE = false; + +/** + * Default interval in milliseconds for event loop yields (e.g. to allow network activity or to refresh the screen with the HTML-based runner). Small values here may result in slow test running. Zero means no updates until all tests have completed. + * + */ +jasmine.DEFAULT_UPDATE_INTERVAL = 250; + +/** + * Default timeout interval in milliseconds for waitsFor() blocks. + */ +jasmine.DEFAULT_TIMEOUT_INTERVAL = 5000; + +jasmine.getGlobal = function() { + function getGlobal() { + return this; + } + + return getGlobal(); +}; + +/** + * Allows for bound functions to be compared. Internal use only. + * + * @ignore + * @private + * @param base {Object} bound 'this' for the function + * @param name {Function} function to find + */ +jasmine.bindOriginal_ = function(base, name) { + var original = base[name]; + if (original.apply) { + return function() { + return original.apply(base, arguments); + }; + } else { + // IE support + return jasmine.getGlobal()[name]; + } +}; + +jasmine.setTimeout = jasmine.bindOriginal_(jasmine.getGlobal(), 'setTimeout'); +jasmine.clearTimeout = jasmine.bindOriginal_(jasmine.getGlobal(), 'clearTimeout'); +jasmine.setInterval = jasmine.bindOriginal_(jasmine.getGlobal(), 'setInterval'); +jasmine.clearInterval = jasmine.bindOriginal_(jasmine.getGlobal(), 'clearInterval'); + +jasmine.MessageResult = function(values) { + this.type = 'log'; + this.values = values; + this.trace = new Error(); // todo: test better +}; + +jasmine.MessageResult.prototype.toString = function() { + var text = ""; + for (var i = 0; i < this.values.length; i++) { + if (i > 0) text += " "; + if (jasmine.isString_(this.values[i])) { + text += this.values[i]; + } else { + text += jasmine.pp(this.values[i]); + } + } + return text; +}; + +jasmine.ExpectationResult = function(params) { + this.type = 'expect'; + this.matcherName = params.matcherName; + this.passed_ = params.passed; + this.expected = params.expected; + this.actual = params.actual; + this.message = this.passed_ ? 'Passed.' : params.message; + + var trace = (params.trace || new Error(this.message)); + this.trace = this.passed_ ? '' : trace; +}; + +jasmine.ExpectationResult.prototype.toString = function () { + return this.message; +}; + +jasmine.ExpectationResult.prototype.passed = function () { + return this.passed_; +}; + +/** + * Getter for the Jasmine environment. Ensures one gets created + */ +jasmine.getEnv = function() { + var env = jasmine.currentEnv_ = jasmine.currentEnv_ || new jasmine.Env(); + return env; +}; + +/** + * @ignore + * @private + * @param value + * @returns {Boolean} + */ +jasmine.isArray_ = function(value) { + return jasmine.isA_("Array", value); +}; + +/** + * @ignore + * @private + * @param value + * @returns {Boolean} + */ +jasmine.isString_ = function(value) { + return jasmine.isA_("String", value); +}; + +/** + * @ignore + * @private + * @param value + * @returns {Boolean} + */ +jasmine.isNumber_ = function(value) { + return jasmine.isA_("Number", value); +}; + +/** + * @ignore + * @private + * @param {String} typeName + * @param value + * @returns {Boolean} + */ +jasmine.isA_ = function(typeName, value) { + return Object.prototype.toString.apply(value) === '[object ' + typeName + ']'; +}; + +/** + * Pretty printer for expecations. Takes any object and turns it into a human-readable string. + * + * @param value {Object} an object to be outputted + * @returns {String} + */ +jasmine.pp = function(value) { + var stringPrettyPrinter = new jasmine.StringPrettyPrinter(); + stringPrettyPrinter.format(value); + return stringPrettyPrinter.string; +}; + +/** + * Returns true if the object is a DOM Node. + * + * @param {Object} obj object to check + * @returns {Boolean} + */ +jasmine.isDomNode = function(obj) { + return obj.nodeType > 0; +}; + +/** + * Returns a matchable 'generic' object of the class type. For use in expecations of type when values don't matter. + * + * @example + * // don't care about which function is passed in, as long as it's a function + * expect(mySpy).toHaveBeenCalledWith(jasmine.any(Function)); + * + * @param {Class} clazz + * @returns matchable object of the type clazz + */ +jasmine.any = function(clazz) { + return new jasmine.Matchers.Any(clazz); +}; + +/** + * Returns a matchable subset of a JSON object. For use in expectations when you don't care about all of the + * attributes on the object. + * + * @example + * // don't care about any other attributes than foo. + * expect(mySpy).toHaveBeenCalledWith(jasmine.objectContaining({foo: "bar"}); + * + * @param sample {Object} sample + * @returns matchable object for the sample + */ +jasmine.objectContaining = function (sample) { + return new jasmine.Matchers.ObjectContaining(sample); +}; + +/** + * Jasmine Spies are test doubles that can act as stubs, spies, fakes or when used in an expecation, mocks. + * + * Spies should be created in test setup, before expectations. They can then be checked, using the standard Jasmine + * expectation syntax. Spies can be checked if they were called or not and what the calling params were. + * + * A Spy has the following fields: wasCalled, callCount, mostRecentCall, and argsForCall (see docs). + * + * Spies are torn down at the end of every spec. + * + * Note: Do not call new jasmine.Spy() directly - a spy must be created using spyOn, jasmine.createSpy or jasmine.createSpyObj. + * + * @example + * // a stub + * var myStub = jasmine.createSpy('myStub'); // can be used anywhere + * + * // spy example + * var foo = { + * not: function(bool) { return !bool; } + * } + * + * // actual foo.not will not be called, execution stops + * spyOn(foo, 'not'); + + // foo.not spied upon, execution will continue to implementation + * spyOn(foo, 'not').andCallThrough(); + * + * // fake example + * var foo = { + * not: function(bool) { return !bool; } + * } + * + * // foo.not(val) will return val + * spyOn(foo, 'not').andCallFake(function(value) {return value;}); + * + * // mock example + * foo.not(7 == 7); + * expect(foo.not).toHaveBeenCalled(); + * expect(foo.not).toHaveBeenCalledWith(true); + * + * @constructor + * @see spyOn, jasmine.createSpy, jasmine.createSpyObj + * @param {String} name + */ +jasmine.Spy = function(name) { + /** + * The name of the spy, if provided. + */ + this.identity = name || 'unknown'; + /** + * Is this Object a spy? + */ + this.isSpy = true; + /** + * The actual function this spy stubs. + */ + this.plan = function() { + }; + /** + * Tracking of the most recent call to the spy. + * @example + * var mySpy = jasmine.createSpy('foo'); + * mySpy(1, 2); + * mySpy.mostRecentCall.args = [1, 2]; + */ + this.mostRecentCall = {}; + + /** + * Holds arguments for each call to the spy, indexed by call count + * @example + * var mySpy = jasmine.createSpy('foo'); + * mySpy(1, 2); + * mySpy(7, 8); + * mySpy.mostRecentCall.args = [7, 8]; + * mySpy.argsForCall[0] = [1, 2]; + * mySpy.argsForCall[1] = [7, 8]; + */ + this.argsForCall = []; + this.calls = []; +}; + +/** + * Tells a spy to call through to the actual implemenatation. + * + * @example + * var foo = { + * bar: function() { // do some stuff } + * } + * + * // defining a spy on an existing property: foo.bar + * spyOn(foo, 'bar').andCallThrough(); + */ +jasmine.Spy.prototype.andCallThrough = function() { + this.plan = this.originalValue; + return this; +}; + +/** + * For setting the return value of a spy. + * + * @example + * // defining a spy from scratch: foo() returns 'baz' + * var foo = jasmine.createSpy('spy on foo').andReturn('baz'); + * + * // defining a spy on an existing property: foo.bar() returns 'baz' + * spyOn(foo, 'bar').andReturn('baz'); + * + * @param {Object} value + */ +jasmine.Spy.prototype.andReturn = function(value) { + this.plan = function() { + return value; + }; + return this; +}; + +/** + * For throwing an exception when a spy is called. + * + * @example + * // defining a spy from scratch: foo() throws an exception w/ message 'ouch' + * var foo = jasmine.createSpy('spy on foo').andThrow('baz'); + * + * // defining a spy on an existing property: foo.bar() throws an exception w/ message 'ouch' + * spyOn(foo, 'bar').andThrow('baz'); + * + * @param {String} exceptionMsg + */ +jasmine.Spy.prototype.andThrow = function(exceptionMsg) { + this.plan = function() { + throw exceptionMsg; + }; + return this; +}; + +/** + * Calls an alternate implementation when a spy is called. + * + * @example + * var baz = function() { + * // do some stuff, return something + * } + * // defining a spy from scratch: foo() calls the function baz + * var foo = jasmine.createSpy('spy on foo').andCall(baz); + * + * // defining a spy on an existing property: foo.bar() calls an anonymnous function + * spyOn(foo, 'bar').andCall(function() { return 'baz';} ); + * + * @param {Function} fakeFunc + */ +jasmine.Spy.prototype.andCallFake = function(fakeFunc) { + this.plan = fakeFunc; + return this; +}; + +/** + * Resets all of a spy's the tracking variables so that it can be used again. + * + * @example + * spyOn(foo, 'bar'); + * + * foo.bar(); + * + * expect(foo.bar.callCount).toEqual(1); + * + * foo.bar.reset(); + * + * expect(foo.bar.callCount).toEqual(0); + */ +jasmine.Spy.prototype.reset = function() { + this.wasCalled = false; + this.callCount = 0; + this.argsForCall = []; + this.calls = []; + this.mostRecentCall = {}; +}; + +jasmine.createSpy = function(name) { + + var spyObj = function() { + spyObj.wasCalled = true; + spyObj.callCount++; + var args = jasmine.util.argsToArray(arguments); + spyObj.mostRecentCall.object = this; + spyObj.mostRecentCall.args = args; + spyObj.argsForCall.push(args); + spyObj.calls.push({object: this, args: args}); + return spyObj.plan.apply(this, arguments); + }; + + var spy = new jasmine.Spy(name); + + for (var prop in spy) { + spyObj[prop] = spy[prop]; + } + + spyObj.reset(); + + return spyObj; +}; + +/** + * Determines whether an object is a spy. + * + * @param {jasmine.Spy|Object} putativeSpy + * @returns {Boolean} + */ +jasmine.isSpy = function(putativeSpy) { + return putativeSpy && putativeSpy.isSpy; +}; + +/** + * Creates a more complicated spy: an Object that has every property a function that is a spy. Used for stubbing something + * large in one call. + * + * @param {String} baseName name of spy class + * @param {Array} methodNames array of names of methods to make spies + */ +jasmine.createSpyObj = function(baseName, methodNames) { + if (!jasmine.isArray_(methodNames) || methodNames.length === 0) { + throw new Error('createSpyObj requires a non-empty array of method names to create spies for'); + } + var obj = {}; + for (var i = 0; i < methodNames.length; i++) { + obj[methodNames[i]] = jasmine.createSpy(baseName + '.' + methodNames[i]); + } + return obj; +}; + +/** + * All parameters are pretty-printed and concatenated together, then written to the current spec's output. + * + * Be careful not to leave calls to jasmine.log in production code. + */ +jasmine.log = function() { + var spec = jasmine.getEnv().currentSpec; + spec.log.apply(spec, arguments); +}; + +/** + * Function that installs a spy on an existing object's method name. Used within a Spec to create a spy. + * + * @example + * // spy example + * var foo = { + * not: function(bool) { return !bool; } + * } + * spyOn(foo, 'not'); // actual foo.not will not be called, execution stops + * + * @see jasmine.createSpy + * @param obj + * @param methodName + * @returns a Jasmine spy that can be chained with all spy methods + */ +var spyOn = function(obj, methodName) { + return jasmine.getEnv().currentSpec.spyOn(obj, methodName); +}; +if (isCommonJS) exports.spyOn = spyOn; + +/** + * Creates a Jasmine spec that will be added to the current suite. + * + * // TODO: pending tests + * + * @example + * it('should be true', function() { + * expect(true).toEqual(true); + * }); + * + * @param {String} desc description of this specification + * @param {Function} func defines the preconditions and expectations of the spec + */ +var it = function(desc, func) { + return jasmine.getEnv().it(desc, func); +}; +if (isCommonJS) exports.it = it; + +/** + * Creates a disabled Jasmine spec. + * + * A convenience method that allows existing specs to be disabled temporarily during development. + * + * @param {String} desc description of this specification + * @param {Function} func defines the preconditions and expectations of the spec + */ +var xit = function(desc, func) { + return jasmine.getEnv().xit(desc, func); +}; +if (isCommonJS) exports.xit = xit; + +/** + * Starts a chain for a Jasmine expectation. + * + * It is passed an Object that is the actual value and should chain to one of the many + * jasmine.Matchers functions. + * + * @param {Object} actual Actual value to test against and expected value + */ +var expect = function(actual) { + return jasmine.getEnv().currentSpec.expect(actual); +}; +if (isCommonJS) exports.expect = expect; + +/** + * Defines part of a jasmine spec. Used in cominbination with waits or waitsFor in asynchrnous specs. + * + * @param {Function} func Function that defines part of a jasmine spec. + */ +var runs = function(func) { + jasmine.getEnv().currentSpec.runs(func); +}; +if (isCommonJS) exports.runs = runs; + +/** + * Waits a fixed time period before moving to the next block. + * + * @deprecated Use waitsFor() instead + * @param {Number} timeout milliseconds to wait + */ +var waits = function(timeout) { + jasmine.getEnv().currentSpec.waits(timeout); +}; +if (isCommonJS) exports.waits = waits; + +/** + * Waits for the latchFunction to return true before proceeding to the next block. + * + * @param {Function} latchFunction + * @param {String} optional_timeoutMessage + * @param {Number} optional_timeout + */ +var waitsFor = function(latchFunction, optional_timeoutMessage, optional_timeout) { + jasmine.getEnv().currentSpec.waitsFor.apply(jasmine.getEnv().currentSpec, arguments); +}; +if (isCommonJS) exports.waitsFor = waitsFor; + +/** + * A function that is called before each spec in a suite. + * + * Used for spec setup, including validating assumptions. + * + * @param {Function} beforeEachFunction + */ +var beforeEach = function(beforeEachFunction) { + jasmine.getEnv().beforeEach(beforeEachFunction); +}; +if (isCommonJS) exports.beforeEach = beforeEach; + +/** + * A function that is called after each spec in a suite. + * + * Used for restoring any state that is hijacked during spec execution. + * + * @param {Function} afterEachFunction + */ +var afterEach = function(afterEachFunction) { + jasmine.getEnv().afterEach(afterEachFunction); +}; +if (isCommonJS) exports.afterEach = afterEach; + +/** + * Defines a suite of specifications. + * + * Stores the description and all defined specs in the Jasmine environment as one suite of specs. Variables declared + * are accessible by calls to beforeEach, it, and afterEach. Describe blocks can be nested, allowing for specialization + * of setup in some tests. + * + * @example + * // TODO: a simple suite + * + * // TODO: a simple suite with a nested describe block + * + * @param {String} description A string, usually the class under test. + * @param {Function} specDefinitions function that defines several specs. + */ +var describe = function(description, specDefinitions) { + return jasmine.getEnv().describe(description, specDefinitions); +}; +if (isCommonJS) exports.describe = describe; + +/** + * Disables a suite of specifications. Used to disable some suites in a file, or files, temporarily during development. + * + * @param {String} description A string, usually the class under test. + * @param {Function} specDefinitions function that defines several specs. + */ +var xdescribe = function(description, specDefinitions) { + return jasmine.getEnv().xdescribe(description, specDefinitions); +}; +if (isCommonJS) exports.xdescribe = xdescribe; + + +// Provide the XMLHttpRequest class for IE 5.x-6.x: +jasmine.XmlHttpRequest = (typeof XMLHttpRequest == "undefined") ? function() { + function tryIt(f) { + try { + return f(); + } catch(e) { + } + return null; + } + + var xhr = tryIt(function() { + return new ActiveXObject("Msxml2.XMLHTTP.6.0"); + }) || + tryIt(function() { + return new ActiveXObject("Msxml2.XMLHTTP.3.0"); + }) || + tryIt(function() { + return new ActiveXObject("Msxml2.XMLHTTP"); + }) || + tryIt(function() { + return new ActiveXObject("Microsoft.XMLHTTP"); + }); + + if (!xhr) throw new Error("This browser does not support XMLHttpRequest."); + + return xhr; +} : XMLHttpRequest; +/** + * @namespace + */ +jasmine.util = {}; + +/** + * Declare that a child class inherit it's prototype from the parent class. + * + * @private + * @param {Function} childClass + * @param {Function} parentClass + */ +jasmine.util.inherit = function(childClass, parentClass) { + /** + * @private + */ + var subclass = function() { + }; + subclass.prototype = parentClass.prototype; + childClass.prototype = new subclass(); +}; + +jasmine.util.formatException = function(e) { + var lineNumber; + if (e.line) { + lineNumber = e.line; + } + else if (e.lineNumber) { + lineNumber = e.lineNumber; + } + + var file; + + if (e.sourceURL) { + file = e.sourceURL; + } + else if (e.fileName) { + file = e.fileName; + } + + var message = (e.name && e.message) ? (e.name + ': ' + e.message) : e.toString(); + + if (file && lineNumber) { + message += ' in ' + file + ' (line ' + lineNumber + ')'; + } + + return message; +}; + +jasmine.util.htmlEscape = function(str) { + if (!str) return str; + return str.replace(/&/g, '&') + .replace(//g, '>'); +}; + +jasmine.util.argsToArray = function(args) { + var arrayOfArgs = []; + for (var i = 0; i < args.length; i++) arrayOfArgs.push(args[i]); + return arrayOfArgs; +}; + +jasmine.util.extend = function(destination, source) { + for (var property in source) destination[property] = source[property]; + return destination; +}; + +/** + * Environment for Jasmine + * + * @constructor + */ +jasmine.Env = function() { + this.currentSpec = null; + this.currentSuite = null; + this.currentRunner_ = new jasmine.Runner(this); + + this.reporter = new jasmine.MultiReporter(); + + this.updateInterval = jasmine.DEFAULT_UPDATE_INTERVAL; + this.defaultTimeoutInterval = jasmine.DEFAULT_TIMEOUT_INTERVAL; + this.lastUpdate = 0; + this.specFilter = function() { + return true; + }; + + this.nextSpecId_ = 0; + this.nextSuiteId_ = 0; + this.equalityTesters_ = []; + + // wrap matchers + this.matchersClass = function() { + jasmine.Matchers.apply(this, arguments); + }; + jasmine.util.inherit(this.matchersClass, jasmine.Matchers); + + jasmine.Matchers.wrapInto_(jasmine.Matchers.prototype, this.matchersClass); +}; + + +jasmine.Env.prototype.setTimeout = jasmine.setTimeout; +jasmine.Env.prototype.clearTimeout = jasmine.clearTimeout; +jasmine.Env.prototype.setInterval = jasmine.setInterval; +jasmine.Env.prototype.clearInterval = jasmine.clearInterval; + +/** + * @returns an object containing jasmine version build info, if set. + */ +jasmine.Env.prototype.version = function () { + if (jasmine.version_) { + return jasmine.version_; + } else { + throw new Error('Version not set'); + } +}; + +/** + * @returns string containing jasmine version build info, if set. + */ +jasmine.Env.prototype.versionString = function() { + if (!jasmine.version_) { + return "version unknown"; + } + + var version = this.version(); + var versionString = version.major + "." + version.minor + "." + version.build; + if (version.release_candidate) { + versionString += ".rc" + version.release_candidate; + } + versionString += " revision " + version.revision; + return versionString; +}; + +/** + * @returns a sequential integer starting at 0 + */ +jasmine.Env.prototype.nextSpecId = function () { + return this.nextSpecId_++; +}; + +/** + * @returns a sequential integer starting at 0 + */ +jasmine.Env.prototype.nextSuiteId = function () { + return this.nextSuiteId_++; +}; + +/** + * Register a reporter to receive status updates from Jasmine. + * @param {jasmine.Reporter} reporter An object which will receive status updates. + */ +jasmine.Env.prototype.addReporter = function(reporter) { + this.reporter.addReporter(reporter); +}; + +jasmine.Env.prototype.execute = function() { + this.currentRunner_.execute(); +}; + +jasmine.Env.prototype.describe = function(description, specDefinitions) { + var suite = new jasmine.Suite(this, description, specDefinitions, this.currentSuite); + + var parentSuite = this.currentSuite; + if (parentSuite) { + parentSuite.add(suite); + } else { + this.currentRunner_.add(suite); + } + + this.currentSuite = suite; + + var declarationError = null; + try { + specDefinitions.call(suite); + } catch(e) { + declarationError = e; + } + + if (declarationError) { + this.it("encountered a declaration exception", function() { + throw declarationError; + }); + } + + this.currentSuite = parentSuite; + + return suite; +}; + +jasmine.Env.prototype.beforeEach = function(beforeEachFunction) { + if (this.currentSuite) { + this.currentSuite.beforeEach(beforeEachFunction); + } else { + this.currentRunner_.beforeEach(beforeEachFunction); + } +}; + +jasmine.Env.prototype.currentRunner = function () { + return this.currentRunner_; +}; + +jasmine.Env.prototype.afterEach = function(afterEachFunction) { + if (this.currentSuite) { + this.currentSuite.afterEach(afterEachFunction); + } else { + this.currentRunner_.afterEach(afterEachFunction); + } + +}; + +jasmine.Env.prototype.xdescribe = function(desc, specDefinitions) { + return { + execute: function() { + } + }; +}; + +jasmine.Env.prototype.it = function(description, func) { + var spec = new jasmine.Spec(this, this.currentSuite, description); + this.currentSuite.add(spec); + this.currentSpec = spec; + + if (func) { + spec.runs(func); + } + + return spec; +}; + +jasmine.Env.prototype.xit = function(desc, func) { + return { + id: this.nextSpecId(), + runs: function() { + } + }; +}; + +jasmine.Env.prototype.compareObjects_ = function(a, b, mismatchKeys, mismatchValues) { + if (a.__Jasmine_been_here_before__ === b && b.__Jasmine_been_here_before__ === a) { + return true; + } + + a.__Jasmine_been_here_before__ = b; + b.__Jasmine_been_here_before__ = a; + + var hasKey = function(obj, keyName) { + return obj !== null && obj[keyName] !== jasmine.undefined; + }; + + for (var property in b) { + if (!hasKey(a, property) && hasKey(b, property)) { + mismatchKeys.push("expected has key '" + property + "', but missing from actual."); + } + } + for (property in a) { + if (!hasKey(b, property) && hasKey(a, property)) { + mismatchKeys.push("expected missing key '" + property + "', but present in actual."); + } + } + for (property in b) { + if (property == '__Jasmine_been_here_before__') continue; + if (!this.equals_(a[property], b[property], mismatchKeys, mismatchValues)) { + mismatchValues.push("'" + property + "' was '" + (b[property] ? jasmine.util.htmlEscape(b[property].toString()) : b[property]) + "' in expected, but was '" + (a[property] ? jasmine.util.htmlEscape(a[property].toString()) : a[property]) + "' in actual."); + } + } + + if (jasmine.isArray_(a) && jasmine.isArray_(b) && a.length != b.length) { + mismatchValues.push("arrays were not the same length"); + } + + delete a.__Jasmine_been_here_before__; + delete b.__Jasmine_been_here_before__; + return (mismatchKeys.length === 0 && mismatchValues.length === 0); +}; + +jasmine.Env.prototype.equals_ = function(a, b, mismatchKeys, mismatchValues) { + mismatchKeys = mismatchKeys || []; + mismatchValues = mismatchValues || []; + + for (var i = 0; i < this.equalityTesters_.length; i++) { + var equalityTester = this.equalityTesters_[i]; + var result = equalityTester(a, b, this, mismatchKeys, mismatchValues); + if (result !== jasmine.undefined) return result; + } + + if (a === b) return true; + + if (a === jasmine.undefined || a === null || b === jasmine.undefined || b === null) { + return (a == jasmine.undefined && b == jasmine.undefined); + } + + if (jasmine.isDomNode(a) && jasmine.isDomNode(b)) { + return a === b; + } + + if (a instanceof Date && b instanceof Date) { + return a.getTime() == b.getTime(); + } + + if (a.jasmineMatches) { + return a.jasmineMatches(b); + } + + if (b.jasmineMatches) { + return b.jasmineMatches(a); + } + + if (a instanceof jasmine.Matchers.ObjectContaining) { + return a.matches(b); + } + + if (b instanceof jasmine.Matchers.ObjectContaining) { + return b.matches(a); + } + + if (jasmine.isString_(a) && jasmine.isString_(b)) { + return (a == b); + } + + if (jasmine.isNumber_(a) && jasmine.isNumber_(b)) { + return (a == b); + } + + if (typeof a === "object" && typeof b === "object") { + return this.compareObjects_(a, b, mismatchKeys, mismatchValues); + } + + //Straight check + return (a === b); +}; + +jasmine.Env.prototype.contains_ = function(haystack, needle) { + if (jasmine.isArray_(haystack)) { + for (var i = 0; i < haystack.length; i++) { + if (this.equals_(haystack[i], needle)) return true; + } + return false; + } + return haystack.indexOf(needle) >= 0; +}; + +jasmine.Env.prototype.addEqualityTester = function(equalityTester) { + this.equalityTesters_.push(equalityTester); +}; +/** No-op base class for Jasmine reporters. + * + * @constructor + */ +jasmine.Reporter = function() { +}; + +//noinspection JSUnusedLocalSymbols +jasmine.Reporter.prototype.reportRunnerStarting = function(runner) { +}; + +//noinspection JSUnusedLocalSymbols +jasmine.Reporter.prototype.reportRunnerResults = function(runner) { +}; + +//noinspection JSUnusedLocalSymbols +jasmine.Reporter.prototype.reportSuiteResults = function(suite) { +}; + +//noinspection JSUnusedLocalSymbols +jasmine.Reporter.prototype.reportSpecStarting = function(spec) { +}; + +//noinspection JSUnusedLocalSymbols +jasmine.Reporter.prototype.reportSpecResults = function(spec) { +}; + +//noinspection JSUnusedLocalSymbols +jasmine.Reporter.prototype.log = function(str) { +}; + +/** + * Blocks are functions with executable code that make up a spec. + * + * @constructor + * @param {jasmine.Env} env + * @param {Function} func + * @param {jasmine.Spec} spec + */ +jasmine.Block = function(env, func, spec) { + this.env = env; + this.func = func; + this.spec = spec; +}; + +jasmine.Block.prototype.execute = function(onComplete) { + try { + this.func.apply(this.spec); + } catch (e) { + this.spec.fail(e); + } + onComplete(); +}; +/** JavaScript API reporter. + * + * @constructor + */ +jasmine.JsApiReporter = function() { + this.started = false; + this.finished = false; + this.suites_ = []; + this.results_ = {}; +}; + +jasmine.JsApiReporter.prototype.reportRunnerStarting = function(runner) { + this.started = true; + var suites = runner.topLevelSuites(); + for (var i = 0; i < suites.length; i++) { + var suite = suites[i]; + this.suites_.push(this.summarize_(suite)); + } +}; + +jasmine.JsApiReporter.prototype.suites = function() { + return this.suites_; +}; + +jasmine.JsApiReporter.prototype.summarize_ = function(suiteOrSpec) { + var isSuite = suiteOrSpec instanceof jasmine.Suite; + var summary = { + id: suiteOrSpec.id, + name: suiteOrSpec.description, + type: isSuite ? 'suite' : 'spec', + children: [] + }; + + if (isSuite) { + var children = suiteOrSpec.children(); + for (var i = 0; i < children.length; i++) { + summary.children.push(this.summarize_(children[i])); + } + } + return summary; +}; + +jasmine.JsApiReporter.prototype.results = function() { + return this.results_; +}; + +jasmine.JsApiReporter.prototype.resultsForSpec = function(specId) { + return this.results_[specId]; +}; + +//noinspection JSUnusedLocalSymbols +jasmine.JsApiReporter.prototype.reportRunnerResults = function(runner) { + this.finished = true; +}; + +//noinspection JSUnusedLocalSymbols +jasmine.JsApiReporter.prototype.reportSuiteResults = function(suite) { +}; + +//noinspection JSUnusedLocalSymbols +jasmine.JsApiReporter.prototype.reportSpecResults = function(spec) { + this.results_[spec.id] = { + messages: spec.results().getItems(), + result: spec.results().failedCount > 0 ? "failed" : "passed" + }; +}; + +//noinspection JSUnusedLocalSymbols +jasmine.JsApiReporter.prototype.log = function(str) { +}; + +jasmine.JsApiReporter.prototype.resultsForSpecs = function(specIds){ + var results = {}; + for (var i = 0; i < specIds.length; i++) { + var specId = specIds[i]; + results[specId] = this.summarizeResult_(this.results_[specId]); + } + return results; +}; + +jasmine.JsApiReporter.prototype.summarizeResult_ = function(result){ + var summaryMessages = []; + var messagesLength = result.messages.length; + for (var messageIndex = 0; messageIndex < messagesLength; messageIndex++) { + var resultMessage = result.messages[messageIndex]; + summaryMessages.push({ + text: resultMessage.type == 'log' ? resultMessage.toString() : jasmine.undefined, + passed: resultMessage.passed ? resultMessage.passed() : true, + type: resultMessage.type, + message: resultMessage.message, + trace: { + stack: resultMessage.passed && !resultMessage.passed() ? resultMessage.trace.stack : jasmine.undefined + } + }); + } + + return { + result : result.result, + messages : summaryMessages + }; +}; + +/** + * @constructor + * @param {jasmine.Env} env + * @param actual + * @param {jasmine.Spec} spec + */ +jasmine.Matchers = function(env, actual, spec, opt_isNot) { + this.env = env; + this.actual = actual; + this.spec = spec; + this.isNot = opt_isNot || false; + this.reportWasCalled_ = false; +}; + +// todo: @deprecated as of Jasmine 0.11, remove soon [xw] +jasmine.Matchers.pp = function(str) { + throw new Error("jasmine.Matchers.pp() is no longer supported, please use jasmine.pp() instead!"); +}; + +// todo: @deprecated Deprecated as of Jasmine 0.10. Rewrite your custom matchers to return true or false. [xw] +jasmine.Matchers.prototype.report = function(result, failing_message, details) { + throw new Error("As of jasmine 0.11, custom matchers must be implemented differently -- please see jasmine docs"); +}; + +jasmine.Matchers.wrapInto_ = function(prototype, matchersClass) { + for (var methodName in prototype) { + if (methodName == 'report') continue; + var orig = prototype[methodName]; + matchersClass.prototype[methodName] = jasmine.Matchers.matcherFn_(methodName, orig); + } +}; + +jasmine.Matchers.matcherFn_ = function(matcherName, matcherFunction) { + return function() { + var matcherArgs = jasmine.util.argsToArray(arguments); + var result = matcherFunction.apply(this, arguments); + + if (this.isNot) { + result = !result; + } + + if (this.reportWasCalled_) return result; + + var message; + if (!result) { + if (this.message) { + message = this.message.apply(this, arguments); + if (jasmine.isArray_(message)) { + message = message[this.isNot ? 1 : 0]; + } + } else { + var englishyPredicate = matcherName.replace(/[A-Z]/g, function(s) { return ' ' + s.toLowerCase(); }); + message = "Expected " + jasmine.pp(this.actual) + (this.isNot ? " not " : " ") + englishyPredicate; + if (matcherArgs.length > 0) { + for (var i = 0; i < matcherArgs.length; i++) { + if (i > 0) message += ","; + message += " " + jasmine.pp(matcherArgs[i]); + } + } + message += "."; + } + } + var expectationResult = new jasmine.ExpectationResult({ + matcherName: matcherName, + passed: result, + expected: matcherArgs.length > 1 ? matcherArgs : matcherArgs[0], + actual: this.actual, + message: message + }); + this.spec.addMatcherResult(expectationResult); + return jasmine.undefined; + }; +}; + + + + +/** + * toBe: compares the actual to the expected using === + * @param expected + */ +jasmine.Matchers.prototype.toBe = function(expected) { + return this.actual === expected; +}; + +/** + * toNotBe: compares the actual to the expected using !== + * @param expected + * @deprecated as of 1.0. Use not.toBe() instead. + */ +jasmine.Matchers.prototype.toNotBe = function(expected) { + return this.actual !== expected; +}; + +/** + * toEqual: compares the actual to the expected using common sense equality. Handles Objects, Arrays, etc. + * + * @param expected + */ +jasmine.Matchers.prototype.toEqual = function(expected) { + return this.env.equals_(this.actual, expected); +}; + +/** + * toNotEqual: compares the actual to the expected using the ! of jasmine.Matchers.toEqual + * @param expected + * @deprecated as of 1.0. Use not.toEqual() instead. + */ +jasmine.Matchers.prototype.toNotEqual = function(expected) { + return !this.env.equals_(this.actual, expected); +}; + +/** + * Matcher that compares the actual to the expected using a regular expression. Constructs a RegExp, so takes + * a pattern or a String. + * + * @param expected + */ +jasmine.Matchers.prototype.toMatch = function(expected) { + return new RegExp(expected).test(this.actual); +}; + +/** + * Matcher that compares the actual to the expected using the boolean inverse of jasmine.Matchers.toMatch + * @param expected + * @deprecated as of 1.0. Use not.toMatch() instead. + */ +jasmine.Matchers.prototype.toNotMatch = function(expected) { + return !(new RegExp(expected).test(this.actual)); +}; + +/** + * Matcher that compares the actual to jasmine.undefined. + */ +jasmine.Matchers.prototype.toBeDefined = function() { + return (this.actual !== jasmine.undefined); +}; + +/** + * Matcher that compares the actual to jasmine.undefined. + */ +jasmine.Matchers.prototype.toBeUndefined = function() { + return (this.actual === jasmine.undefined); +}; + +/** + * Matcher that compares the actual to null. + */ +jasmine.Matchers.prototype.toBeNull = function() { + return (this.actual === null); +}; + +/** + * Matcher that boolean not-nots the actual. + */ +jasmine.Matchers.prototype.toBeTruthy = function() { + return !!this.actual; +}; + + +/** + * Matcher that boolean nots the actual. + */ +jasmine.Matchers.prototype.toBeFalsy = function() { + return !this.actual; +}; + + +/** + * Matcher that checks to see if the actual, a Jasmine spy, was called. + */ +jasmine.Matchers.prototype.toHaveBeenCalled = function() { + if (arguments.length > 0) { + throw new Error('toHaveBeenCalled does not take arguments, use toHaveBeenCalledWith'); + } + + if (!jasmine.isSpy(this.actual)) { + throw new Error('Expected a spy, but got ' + jasmine.pp(this.actual) + '.'); + } + + this.message = function() { + return [ + "Expected spy " + this.actual.identity + " to have been called.", + "Expected spy " + this.actual.identity + " not to have been called." + ]; + }; + + return this.actual.wasCalled; +}; + +/** @deprecated Use expect(xxx).toHaveBeenCalled() instead */ +jasmine.Matchers.prototype.wasCalled = jasmine.Matchers.prototype.toHaveBeenCalled; + +/** + * Matcher that checks to see if the actual, a Jasmine spy, was not called. + * + * @deprecated Use expect(xxx).not.toHaveBeenCalled() instead + */ +jasmine.Matchers.prototype.wasNotCalled = function() { + if (arguments.length > 0) { + throw new Error('wasNotCalled does not take arguments'); + } + + if (!jasmine.isSpy(this.actual)) { + throw new Error('Expected a spy, but got ' + jasmine.pp(this.actual) + '.'); + } + + this.message = function() { + return [ + "Expected spy " + this.actual.identity + " to not have been called.", + "Expected spy " + this.actual.identity + " to have been called." + ]; + }; + + return !this.actual.wasCalled; +}; + +/** + * Matcher that checks to see if the actual, a Jasmine spy, was called with a set of parameters. + * + * @example + * + */ +jasmine.Matchers.prototype.toHaveBeenCalledWith = function() { + var expectedArgs = jasmine.util.argsToArray(arguments); + if (!jasmine.isSpy(this.actual)) { + throw new Error('Expected a spy, but got ' + jasmine.pp(this.actual) + '.'); + } + this.message = function() { + if (this.actual.callCount === 0) { + // todo: what should the failure message for .not.toHaveBeenCalledWith() be? is this right? test better. [xw] + return [ + "Expected spy " + this.actual.identity + " to have been called with " + jasmine.pp(expectedArgs) + " but it was never called.", + "Expected spy " + this.actual.identity + " not to have been called with " + jasmine.pp(expectedArgs) + " but it was." + ]; + } else { + return [ + "Expected spy " + this.actual.identity + " to have been called with " + jasmine.pp(expectedArgs) + " but was called with " + jasmine.pp(this.actual.argsForCall), + "Expected spy " + this.actual.identity + " not to have been called with " + jasmine.pp(expectedArgs) + " but was called with " + jasmine.pp(this.actual.argsForCall) + ]; + } + }; + + return this.env.contains_(this.actual.argsForCall, expectedArgs); +}; + +/** @deprecated Use expect(xxx).toHaveBeenCalledWith() instead */ +jasmine.Matchers.prototype.wasCalledWith = jasmine.Matchers.prototype.toHaveBeenCalledWith; + +/** @deprecated Use expect(xxx).not.toHaveBeenCalledWith() instead */ +jasmine.Matchers.prototype.wasNotCalledWith = function() { + var expectedArgs = jasmine.util.argsToArray(arguments); + if (!jasmine.isSpy(this.actual)) { + throw new Error('Expected a spy, but got ' + jasmine.pp(this.actual) + '.'); + } + + this.message = function() { + return [ + "Expected spy not to have been called with " + jasmine.pp(expectedArgs) + " but it was", + "Expected spy to have been called with " + jasmine.pp(expectedArgs) + " but it was" + ]; + }; + + return !this.env.contains_(this.actual.argsForCall, expectedArgs); +}; + +/** + * Matcher that checks that the expected item is an element in the actual Array. + * + * @param {Object} expected + */ +jasmine.Matchers.prototype.toContain = function(expected) { + return this.env.contains_(this.actual, expected); +}; + +/** + * Matcher that checks that the expected item is NOT an element in the actual Array. + * + * @param {Object} expected + * @deprecated as of 1.0. Use not.toContain() instead. + */ +jasmine.Matchers.prototype.toNotContain = function(expected) { + return !this.env.contains_(this.actual, expected); +}; + +jasmine.Matchers.prototype.toBeLessThan = function(expected) { + return this.actual < expected; +}; + +jasmine.Matchers.prototype.toBeGreaterThan = function(expected) { + return this.actual > expected; +}; + +/** + * Matcher that checks that the expected item is equal to the actual item + * up to a given level of decimal precision (default 2). + * + * @param {Number} expected + * @param {Number} precision + */ +jasmine.Matchers.prototype.toBeCloseTo = function(expected, precision) { + if (!(precision === 0)) { + precision = precision || 2; + } + var multiplier = Math.pow(10, precision); + var actual = Math.round(this.actual * multiplier); + expected = Math.round(expected * multiplier); + return expected == actual; +}; + +/** + * Matcher that checks that the expected exception was thrown by the actual. + * + * @param {String} expected + */ +jasmine.Matchers.prototype.toThrow = function(expected) { + var result = false; + var exception; + if (typeof this.actual != 'function') { + throw new Error('Actual is not a function'); + } + try { + this.actual(); + } catch (e) { + exception = e; + } + if (exception) { + result = (expected === jasmine.undefined || this.env.equals_(exception.message || exception, expected.message || expected)); + } + + var not = this.isNot ? "not " : ""; + + this.message = function() { + if (exception && (expected === jasmine.undefined || !this.env.equals_(exception.message || exception, expected.message || expected))) { + return ["Expected function " + not + "to throw", expected ? expected.message || expected : "an exception", ", but it threw", exception.message || exception].join(' '); + } else { + return "Expected function to throw an exception."; + } + }; + + return result; +}; + +jasmine.Matchers.Any = function(expectedClass) { + this.expectedClass = expectedClass; +}; + +jasmine.Matchers.Any.prototype.jasmineMatches = function(other) { + if (this.expectedClass == String) { + return typeof other == 'string' || other instanceof String; + } + + if (this.expectedClass == Number) { + return typeof other == 'number' || other instanceof Number; + } + + if (this.expectedClass == Function) { + return typeof other == 'function' || other instanceof Function; + } + + if (this.expectedClass == Object) { + return typeof other == 'object'; + } + + return other instanceof this.expectedClass; +}; + +jasmine.Matchers.Any.prototype.jasmineToString = function() { + return ''; +}; + +jasmine.Matchers.ObjectContaining = function (sample) { + this.sample = sample; +}; + +jasmine.Matchers.ObjectContaining.prototype.jasmineMatches = function(other, mismatchKeys, mismatchValues) { + mismatchKeys = mismatchKeys || []; + mismatchValues = mismatchValues || []; + + var env = jasmine.getEnv(); + + var hasKey = function(obj, keyName) { + return obj != null && obj[keyName] !== jasmine.undefined; + }; + + for (var property in this.sample) { + if (!hasKey(other, property) && hasKey(this.sample, property)) { + mismatchKeys.push("expected has key '" + property + "', but missing from actual."); + } + else if (!env.equals_(this.sample[property], other[property], mismatchKeys, mismatchValues)) { + mismatchValues.push("'" + property + "' was '" + (other[property] ? jasmine.util.htmlEscape(other[property].toString()) : other[property]) + "' in expected, but was '" + (this.sample[property] ? jasmine.util.htmlEscape(this.sample[property].toString()) : this.sample[property]) + "' in actual."); + } + } + + return (mismatchKeys.length === 0 && mismatchValues.length === 0); +}; + +jasmine.Matchers.ObjectContaining.prototype.jasmineToString = function () { + return ""; +}; +// Mock setTimeout, clearTimeout +// Contributed by Pivotal Computer Systems, www.pivotalsf.com + +jasmine.FakeTimer = function() { + this.reset(); + + var self = this; + self.setTimeout = function(funcToCall, millis) { + self.timeoutsMade++; + self.scheduleFunction(self.timeoutsMade, funcToCall, millis, false); + return self.timeoutsMade; + }; + + self.setInterval = function(funcToCall, millis) { + self.timeoutsMade++; + self.scheduleFunction(self.timeoutsMade, funcToCall, millis, true); + return self.timeoutsMade; + }; + + self.clearTimeout = function(timeoutKey) { + self.scheduledFunctions[timeoutKey] = jasmine.undefined; + }; + + self.clearInterval = function(timeoutKey) { + self.scheduledFunctions[timeoutKey] = jasmine.undefined; + }; + +}; + +jasmine.FakeTimer.prototype.reset = function() { + this.timeoutsMade = 0; + this.scheduledFunctions = {}; + this.nowMillis = 0; +}; + +jasmine.FakeTimer.prototype.tick = function(millis) { + var oldMillis = this.nowMillis; + var newMillis = oldMillis + millis; + this.runFunctionsWithinRange(oldMillis, newMillis); + this.nowMillis = newMillis; +}; + +jasmine.FakeTimer.prototype.runFunctionsWithinRange = function(oldMillis, nowMillis) { + var scheduledFunc; + var funcsToRun = []; + for (var timeoutKey in this.scheduledFunctions) { + scheduledFunc = this.scheduledFunctions[timeoutKey]; + if (scheduledFunc != jasmine.undefined && + scheduledFunc.runAtMillis >= oldMillis && + scheduledFunc.runAtMillis <= nowMillis) { + funcsToRun.push(scheduledFunc); + this.scheduledFunctions[timeoutKey] = jasmine.undefined; + } + } + + if (funcsToRun.length > 0) { + funcsToRun.sort(function(a, b) { + return a.runAtMillis - b.runAtMillis; + }); + for (var i = 0; i < funcsToRun.length; ++i) { + try { + var funcToRun = funcsToRun[i]; + this.nowMillis = funcToRun.runAtMillis; + funcToRun.funcToCall(); + if (funcToRun.recurring) { + this.scheduleFunction(funcToRun.timeoutKey, + funcToRun.funcToCall, + funcToRun.millis, + true); + } + } catch(e) { + } + } + this.runFunctionsWithinRange(oldMillis, nowMillis); + } +}; + +jasmine.FakeTimer.prototype.scheduleFunction = function(timeoutKey, funcToCall, millis, recurring) { + this.scheduledFunctions[timeoutKey] = { + runAtMillis: this.nowMillis + millis, + funcToCall: funcToCall, + recurring: recurring, + timeoutKey: timeoutKey, + millis: millis + }; +}; + +/** + * @namespace + */ +jasmine.Clock = { + defaultFakeTimer: new jasmine.FakeTimer(), + + reset: function() { + jasmine.Clock.assertInstalled(); + jasmine.Clock.defaultFakeTimer.reset(); + }, + + tick: function(millis) { + jasmine.Clock.assertInstalled(); + jasmine.Clock.defaultFakeTimer.tick(millis); + }, + + runFunctionsWithinRange: function(oldMillis, nowMillis) { + jasmine.Clock.defaultFakeTimer.runFunctionsWithinRange(oldMillis, nowMillis); + }, + + scheduleFunction: function(timeoutKey, funcToCall, millis, recurring) { + jasmine.Clock.defaultFakeTimer.scheduleFunction(timeoutKey, funcToCall, millis, recurring); + }, + + useMock: function() { + if (!jasmine.Clock.isInstalled()) { + var spec = jasmine.getEnv().currentSpec; + spec.after(jasmine.Clock.uninstallMock); + + jasmine.Clock.installMock(); + } + }, + + installMock: function() { + jasmine.Clock.installed = jasmine.Clock.defaultFakeTimer; + }, + + uninstallMock: function() { + jasmine.Clock.assertInstalled(); + jasmine.Clock.installed = jasmine.Clock.real; + }, + + real: { + setTimeout: jasmine.getGlobal().setTimeout, + clearTimeout: jasmine.getGlobal().clearTimeout, + setInterval: jasmine.getGlobal().setInterval, + clearInterval: jasmine.getGlobal().clearInterval + }, + + assertInstalled: function() { + if (!jasmine.Clock.isInstalled()) { + throw new Error("Mock clock is not installed, use jasmine.Clock.useMock()"); + } + }, + + isInstalled: function() { + return jasmine.Clock.installed == jasmine.Clock.defaultFakeTimer; + }, + + installed: null +}; +jasmine.Clock.installed = jasmine.Clock.real; + +//else for IE support +jasmine.getGlobal().setTimeout = function(funcToCall, millis) { + if (jasmine.Clock.installed.setTimeout.apply) { + return jasmine.Clock.installed.setTimeout.apply(this, arguments); + } else { + return jasmine.Clock.installed.setTimeout(funcToCall, millis); + } +}; + +jasmine.getGlobal().setInterval = function(funcToCall, millis) { + if (jasmine.Clock.installed.setInterval.apply) { + return jasmine.Clock.installed.setInterval.apply(this, arguments); + } else { + return jasmine.Clock.installed.setInterval(funcToCall, millis); + } +}; + +jasmine.getGlobal().clearTimeout = function(timeoutKey) { + if (jasmine.Clock.installed.clearTimeout.apply) { + return jasmine.Clock.installed.clearTimeout.apply(this, arguments); + } else { + return jasmine.Clock.installed.clearTimeout(timeoutKey); + } +}; + +jasmine.getGlobal().clearInterval = function(timeoutKey) { + if (jasmine.Clock.installed.clearTimeout.apply) { + return jasmine.Clock.installed.clearInterval.apply(this, arguments); + } else { + return jasmine.Clock.installed.clearInterval(timeoutKey); + } +}; + +/** + * @constructor + */ +jasmine.MultiReporter = function() { + this.subReporters_ = []; +}; +jasmine.util.inherit(jasmine.MultiReporter, jasmine.Reporter); + +jasmine.MultiReporter.prototype.addReporter = function(reporter) { + this.subReporters_.push(reporter); +}; + +(function() { + var functionNames = [ + "reportRunnerStarting", + "reportRunnerResults", + "reportSuiteResults", + "reportSpecStarting", + "reportSpecResults", + "log" + ]; + for (var i = 0; i < functionNames.length; i++) { + var functionName = functionNames[i]; + jasmine.MultiReporter.prototype[functionName] = (function(functionName) { + return function() { + for (var j = 0; j < this.subReporters_.length; j++) { + var subReporter = this.subReporters_[j]; + if (subReporter[functionName]) { + subReporter[functionName].apply(subReporter, arguments); + } + } + }; + })(functionName); + } +})(); +/** + * Holds results for a set of Jasmine spec. Allows for the results array to hold another jasmine.NestedResults + * + * @constructor + */ +jasmine.NestedResults = function() { + /** + * The total count of results + */ + this.totalCount = 0; + /** + * Number of passed results + */ + this.passedCount = 0; + /** + * Number of failed results + */ + this.failedCount = 0; + /** + * Was this suite/spec skipped? + */ + this.skipped = false; + /** + * @ignore + */ + this.items_ = []; +}; + +/** + * Roll up the result counts. + * + * @param result + */ +jasmine.NestedResults.prototype.rollupCounts = function(result) { + this.totalCount += result.totalCount; + this.passedCount += result.passedCount; + this.failedCount += result.failedCount; +}; + +/** + * Adds a log message. + * @param values Array of message parts which will be concatenated later. + */ +jasmine.NestedResults.prototype.log = function(values) { + this.items_.push(new jasmine.MessageResult(values)); +}; + +/** + * Getter for the results: message & results. + */ +jasmine.NestedResults.prototype.getItems = function() { + return this.items_; +}; + +/** + * Adds a result, tracking counts (total, passed, & failed) + * @param {jasmine.ExpectationResult|jasmine.NestedResults} result + */ +jasmine.NestedResults.prototype.addResult = function(result) { + if (result.type != 'log') { + if (result.items_) { + this.rollupCounts(result); + } else { + this.totalCount++; + if (result.passed()) { + this.passedCount++; + } else { + this.failedCount++; + } + } + } + this.items_.push(result); +}; + +/** + * @returns {Boolean} True if everything below passed + */ +jasmine.NestedResults.prototype.passed = function() { + return this.passedCount === this.totalCount; +}; +/** + * Base class for pretty printing for expectation results. + */ +jasmine.PrettyPrinter = function() { + this.ppNestLevel_ = 0; +}; + +/** + * Formats a value in a nice, human-readable string. + * + * @param value + */ +jasmine.PrettyPrinter.prototype.format = function(value) { + if (this.ppNestLevel_ > 40) { + throw new Error('jasmine.PrettyPrinter: format() nested too deeply!'); + } + + this.ppNestLevel_++; + try { + if (value === jasmine.undefined) { + this.emitScalar('undefined'); + } else if (value === null) { + this.emitScalar('null'); + } else if (value === jasmine.getGlobal()) { + this.emitScalar(''); + } else if (value.jasmineToString) { + this.emitScalar(value.jasmineToString()); + } else if (typeof value === 'string') { + this.emitString(value); + } else if (jasmine.isSpy(value)) { + this.emitScalar("spy on " + value.identity); + } else if (value instanceof RegExp) { + this.emitScalar(value.toString()); + } else if (typeof value === 'function') { + this.emitScalar('Function'); + } else if (typeof value.nodeType === 'number') { + this.emitScalar('HTMLNode'); + } else if (value instanceof Date) { + this.emitScalar('Date(' + value + ')'); + } else if (value.__Jasmine_been_here_before__) { + this.emitScalar(''); + } else if (jasmine.isArray_(value) || typeof value == 'object') { + value.__Jasmine_been_here_before__ = true; + if (jasmine.isArray_(value)) { + this.emitArray(value); + } else { + this.emitObject(value); + } + delete value.__Jasmine_been_here_before__; + } else { + this.emitScalar(value.toString()); + } + } finally { + this.ppNestLevel_--; + } +}; + +jasmine.PrettyPrinter.prototype.iterateObject = function(obj, fn) { + for (var property in obj) { + if (property == '__Jasmine_been_here_before__') continue; + fn(property, obj.__lookupGetter__ ? (obj.__lookupGetter__(property) !== jasmine.undefined && + obj.__lookupGetter__(property) !== null) : false); + } +}; + +jasmine.PrettyPrinter.prototype.emitArray = jasmine.unimplementedMethod_; +jasmine.PrettyPrinter.prototype.emitObject = jasmine.unimplementedMethod_; +jasmine.PrettyPrinter.prototype.emitScalar = jasmine.unimplementedMethod_; +jasmine.PrettyPrinter.prototype.emitString = jasmine.unimplementedMethod_; + +jasmine.StringPrettyPrinter = function() { + jasmine.PrettyPrinter.call(this); + + this.string = ''; +}; +jasmine.util.inherit(jasmine.StringPrettyPrinter, jasmine.PrettyPrinter); + +jasmine.StringPrettyPrinter.prototype.emitScalar = function(value) { + this.append(value); +}; + +jasmine.StringPrettyPrinter.prototype.emitString = function(value) { + this.append("'" + value + "'"); +}; + +jasmine.StringPrettyPrinter.prototype.emitArray = function(array) { + this.append('[ '); + for (var i = 0; i < array.length; i++) { + if (i > 0) { + this.append(', '); + } + this.format(array[i]); + } + this.append(' ]'); +}; + +jasmine.StringPrettyPrinter.prototype.emitObject = function(obj) { + var self = this; + this.append('{ '); + var first = true; + + this.iterateObject(obj, function(property, isGetter) { + if (first) { + first = false; + } else { + self.append(', '); + } + + self.append(property); + self.append(' : '); + if (isGetter) { + self.append(''); + } else { + self.format(obj[property]); + } + }); + + this.append(' }'); +}; + +jasmine.StringPrettyPrinter.prototype.append = function(value) { + this.string += value; +}; +jasmine.Queue = function(env) { + this.env = env; + this.blocks = []; + this.running = false; + this.index = 0; + this.offset = 0; + this.abort = false; +}; + +jasmine.Queue.prototype.addBefore = function(block) { + this.blocks.unshift(block); +}; + +jasmine.Queue.prototype.add = function(block) { + this.blocks.push(block); +}; + +jasmine.Queue.prototype.insertNext = function(block) { + this.blocks.splice((this.index + this.offset + 1), 0, block); + this.offset++; +}; + +jasmine.Queue.prototype.start = function(onComplete) { + this.running = true; + this.onComplete = onComplete; + this.next_(); +}; + +jasmine.Queue.prototype.isRunning = function() { + return this.running; +}; + +jasmine.Queue.LOOP_DONT_RECURSE = true; + +jasmine.Queue.prototype.next_ = function() { + var self = this; + var goAgain = true; + + while (goAgain) { + goAgain = false; + + if (self.index < self.blocks.length && !this.abort) { + var calledSynchronously = true; + var completedSynchronously = false; + + var onComplete = function () { + if (jasmine.Queue.LOOP_DONT_RECURSE && calledSynchronously) { + completedSynchronously = true; + return; + } + + if (self.blocks[self.index].abort) { + self.abort = true; + } + + self.offset = 0; + self.index++; + + var now = new Date().getTime(); + if (self.env.updateInterval && now - self.env.lastUpdate > self.env.updateInterval) { + self.env.lastUpdate = now; + self.env.setTimeout(function() { + self.next_(); + }, 0); + } else { + if (jasmine.Queue.LOOP_DONT_RECURSE && completedSynchronously) { + goAgain = true; + } else { + self.next_(); + } + } + }; + self.blocks[self.index].execute(onComplete); + + calledSynchronously = false; + if (completedSynchronously) { + onComplete(); + } + + } else { + self.running = false; + if (self.onComplete) { + self.onComplete(); + } + } + } +}; + +jasmine.Queue.prototype.results = function() { + var results = new jasmine.NestedResults(); + for (var i = 0; i < this.blocks.length; i++) { + if (this.blocks[i].results) { + results.addResult(this.blocks[i].results()); + } + } + return results; +}; + + +/** + * Runner + * + * @constructor + * @param {jasmine.Env} env + */ +jasmine.Runner = function(env) { + var self = this; + self.env = env; + self.queue = new jasmine.Queue(env); + self.before_ = []; + self.after_ = []; + self.suites_ = []; +}; + +jasmine.Runner.prototype.execute = function() { + var self = this; + if (self.env.reporter.reportRunnerStarting) { + self.env.reporter.reportRunnerStarting(this); + } + self.queue.start(function () { + self.finishCallback(); + }); +}; + +jasmine.Runner.prototype.beforeEach = function(beforeEachFunction) { + beforeEachFunction.typeName = 'beforeEach'; + this.before_.splice(0,0,beforeEachFunction); +}; + +jasmine.Runner.prototype.afterEach = function(afterEachFunction) { + afterEachFunction.typeName = 'afterEach'; + this.after_.splice(0,0,afterEachFunction); +}; + + +jasmine.Runner.prototype.finishCallback = function() { + this.env.reporter.reportRunnerResults(this); +}; + +jasmine.Runner.prototype.addSuite = function(suite) { + this.suites_.push(suite); +}; + +jasmine.Runner.prototype.add = function(block) { + if (block instanceof jasmine.Suite) { + this.addSuite(block); + } + this.queue.add(block); +}; + +jasmine.Runner.prototype.specs = function () { + var suites = this.suites(); + var specs = []; + for (var i = 0; i < suites.length; i++) { + specs = specs.concat(suites[i].specs()); + } + return specs; +}; + +jasmine.Runner.prototype.suites = function() { + return this.suites_; +}; + +jasmine.Runner.prototype.topLevelSuites = function() { + var topLevelSuites = []; + for (var i = 0; i < this.suites_.length; i++) { + if (!this.suites_[i].parentSuite) { + topLevelSuites.push(this.suites_[i]); + } + } + return topLevelSuites; +}; + +jasmine.Runner.prototype.results = function() { + return this.queue.results(); +}; +/** + * Internal representation of a Jasmine specification, or test. + * + * @constructor + * @param {jasmine.Env} env + * @param {jasmine.Suite} suite + * @param {String} description + */ +jasmine.Spec = function(env, suite, description) { + if (!env) { + throw new Error('jasmine.Env() required'); + } + if (!suite) { + throw new Error('jasmine.Suite() required'); + } + var spec = this; + spec.id = env.nextSpecId ? env.nextSpecId() : null; + spec.env = env; + spec.suite = suite; + spec.description = description; + spec.queue = new jasmine.Queue(env); + + spec.afterCallbacks = []; + spec.spies_ = []; + + spec.results_ = new jasmine.NestedResults(); + spec.results_.description = description; + spec.matchersClass = null; +}; + +jasmine.Spec.prototype.getFullName = function() { + return this.suite.getFullName() + ' ' + this.description + '.'; +}; + + +jasmine.Spec.prototype.results = function() { + return this.results_; +}; + +/** + * All parameters are pretty-printed and concatenated together, then written to the spec's output. + * + * Be careful not to leave calls to jasmine.log in production code. + */ +jasmine.Spec.prototype.log = function() { + return this.results_.log(arguments); +}; + +jasmine.Spec.prototype.runs = function (func) { + var block = new jasmine.Block(this.env, func, this); + this.addToQueue(block); + return this; +}; + +jasmine.Spec.prototype.addToQueue = function (block) { + if (this.queue.isRunning()) { + this.queue.insertNext(block); + } else { + this.queue.add(block); + } +}; + +/** + * @param {jasmine.ExpectationResult} result + */ +jasmine.Spec.prototype.addMatcherResult = function(result) { + this.results_.addResult(result); +}; + +jasmine.Spec.prototype.expect = function(actual) { + var positive = new (this.getMatchersClass_())(this.env, actual, this); + positive.not = new (this.getMatchersClass_())(this.env, actual, this, true); + return positive; +}; + +/** + * Waits a fixed time period before moving to the next block. + * + * @deprecated Use waitsFor() instead + * @param {Number} timeout milliseconds to wait + */ +jasmine.Spec.prototype.waits = function(timeout) { + var waitsFunc = new jasmine.WaitsBlock(this.env, timeout, this); + this.addToQueue(waitsFunc); + return this; +}; + +/** + * Waits for the latchFunction to return true before proceeding to the next block. + * + * @param {Function} latchFunction + * @param {String} optional_timeoutMessage + * @param {Number} optional_timeout + */ +jasmine.Spec.prototype.waitsFor = function(latchFunction, optional_timeoutMessage, optional_timeout) { + var latchFunction_ = null; + var optional_timeoutMessage_ = null; + var optional_timeout_ = null; + + for (var i = 0; i < arguments.length; i++) { + var arg = arguments[i]; + switch (typeof arg) { + case 'function': + latchFunction_ = arg; + break; + case 'string': + optional_timeoutMessage_ = arg; + break; + case 'number': + optional_timeout_ = arg; + break; + } + } + + var waitsForFunc = new jasmine.WaitsForBlock(this.env, optional_timeout_, latchFunction_, optional_timeoutMessage_, this); + this.addToQueue(waitsForFunc); + return this; +}; + +jasmine.Spec.prototype.fail = function (e) { + var expectationResult = new jasmine.ExpectationResult({ + passed: false, + message: e ? jasmine.util.formatException(e) : 'Exception', + trace: { stack: e.stack } + }); + this.results_.addResult(expectationResult); +}; + +jasmine.Spec.prototype.getMatchersClass_ = function() { + return this.matchersClass || this.env.matchersClass; +}; + +jasmine.Spec.prototype.addMatchers = function(matchersPrototype) { + var parent = this.getMatchersClass_(); + var newMatchersClass = function() { + parent.apply(this, arguments); + }; + jasmine.util.inherit(newMatchersClass, parent); + jasmine.Matchers.wrapInto_(matchersPrototype, newMatchersClass); + this.matchersClass = newMatchersClass; +}; + +jasmine.Spec.prototype.finishCallback = function() { + this.env.reporter.reportSpecResults(this); +}; + +jasmine.Spec.prototype.finish = function(onComplete) { + this.removeAllSpies(); + this.finishCallback(); + if (onComplete) { + onComplete(); + } +}; + +jasmine.Spec.prototype.after = function(doAfter) { + if (this.queue.isRunning()) { + this.queue.add(new jasmine.Block(this.env, doAfter, this)); + } else { + this.afterCallbacks.unshift(doAfter); + } +}; + +jasmine.Spec.prototype.execute = function(onComplete) { + var spec = this; + if (!spec.env.specFilter(spec)) { + spec.results_.skipped = true; + spec.finish(onComplete); + return; + } + + this.env.reporter.reportSpecStarting(this); + + spec.env.currentSpec = spec; + + spec.addBeforesAndAftersToQueue(); + + spec.queue.start(function () { + spec.finish(onComplete); + }); +}; + +jasmine.Spec.prototype.addBeforesAndAftersToQueue = function() { + var runner = this.env.currentRunner(); + var i; + + for (var suite = this.suite; suite; suite = suite.parentSuite) { + for (i = 0; i < suite.before_.length; i++) { + this.queue.addBefore(new jasmine.Block(this.env, suite.before_[i], this)); + } + } + for (i = 0; i < runner.before_.length; i++) { + this.queue.addBefore(new jasmine.Block(this.env, runner.before_[i], this)); + } + for (i = 0; i < this.afterCallbacks.length; i++) { + this.queue.add(new jasmine.Block(this.env, this.afterCallbacks[i], this)); + } + for (suite = this.suite; suite; suite = suite.parentSuite) { + for (i = 0; i < suite.after_.length; i++) { + this.queue.add(new jasmine.Block(this.env, suite.after_[i], this)); + } + } + for (i = 0; i < runner.after_.length; i++) { + this.queue.add(new jasmine.Block(this.env, runner.after_[i], this)); + } +}; + +jasmine.Spec.prototype.explodes = function() { + throw 'explodes function should not have been called'; +}; + +jasmine.Spec.prototype.spyOn = function(obj, methodName, ignoreMethodDoesntExist) { + if (obj == jasmine.undefined) { + throw "spyOn could not find an object to spy upon for " + methodName + "()"; + } + + if (!ignoreMethodDoesntExist && obj[methodName] === jasmine.undefined) { + throw methodName + '() method does not exist'; + } + + if (!ignoreMethodDoesntExist && obj[methodName] && obj[methodName].isSpy) { + throw new Error(methodName + ' has already been spied upon'); + } + + var spyObj = jasmine.createSpy(methodName); + + this.spies_.push(spyObj); + spyObj.baseObj = obj; + spyObj.methodName = methodName; + spyObj.originalValue = obj[methodName]; + + obj[methodName] = spyObj; + + return spyObj; +}; + +jasmine.Spec.prototype.removeAllSpies = function() { + for (var i = 0; i < this.spies_.length; i++) { + var spy = this.spies_[i]; + spy.baseObj[spy.methodName] = spy.originalValue; + } + this.spies_ = []; +}; + +/** + * Internal representation of a Jasmine suite. + * + * @constructor + * @param {jasmine.Env} env + * @param {String} description + * @param {Function} specDefinitions + * @param {jasmine.Suite} parentSuite + */ +jasmine.Suite = function(env, description, specDefinitions, parentSuite) { + var self = this; + self.id = env.nextSuiteId ? env.nextSuiteId() : null; + self.description = description; + self.queue = new jasmine.Queue(env); + self.parentSuite = parentSuite; + self.env = env; + self.before_ = []; + self.after_ = []; + self.children_ = []; + self.suites_ = []; + self.specs_ = []; +}; + +jasmine.Suite.prototype.getFullName = function() { + var fullName = this.description; + for (var parentSuite = this.parentSuite; parentSuite; parentSuite = parentSuite.parentSuite) { + fullName = parentSuite.description + ' ' + fullName; + } + return fullName; +}; + +jasmine.Suite.prototype.finish = function(onComplete) { + this.env.reporter.reportSuiteResults(this); + this.finished = true; + if (typeof(onComplete) == 'function') { + onComplete(); + } +}; + +jasmine.Suite.prototype.beforeEach = function(beforeEachFunction) { + beforeEachFunction.typeName = 'beforeEach'; + this.before_.unshift(beforeEachFunction); +}; + +jasmine.Suite.prototype.afterEach = function(afterEachFunction) { + afterEachFunction.typeName = 'afterEach'; + this.after_.unshift(afterEachFunction); +}; + +jasmine.Suite.prototype.results = function() { + return this.queue.results(); +}; + +jasmine.Suite.prototype.add = function(suiteOrSpec) { + this.children_.push(suiteOrSpec); + if (suiteOrSpec instanceof jasmine.Suite) { + this.suites_.push(suiteOrSpec); + this.env.currentRunner().addSuite(suiteOrSpec); + } else { + this.specs_.push(suiteOrSpec); + } + this.queue.add(suiteOrSpec); +}; + +jasmine.Suite.prototype.specs = function() { + return this.specs_; +}; + +jasmine.Suite.prototype.suites = function() { + return this.suites_; +}; + +jasmine.Suite.prototype.children = function() { + return this.children_; +}; + +jasmine.Suite.prototype.execute = function(onComplete) { + var self = this; + this.queue.start(function () { + self.finish(onComplete); + }); +}; +jasmine.WaitsBlock = function(env, timeout, spec) { + this.timeout = timeout; + jasmine.Block.call(this, env, null, spec); +}; + +jasmine.util.inherit(jasmine.WaitsBlock, jasmine.Block); + +jasmine.WaitsBlock.prototype.execute = function (onComplete) { + if (jasmine.VERBOSE) { + this.env.reporter.log('>> Jasmine waiting for ' + this.timeout + ' ms...'); + } + this.env.setTimeout(function () { + onComplete(); + }, this.timeout); +}; +/** + * A block which waits for some condition to become true, with timeout. + * + * @constructor + * @extends jasmine.Block + * @param {jasmine.Env} env The Jasmine environment. + * @param {Number} timeout The maximum time in milliseconds to wait for the condition to become true. + * @param {Function} latchFunction A function which returns true when the desired condition has been met. + * @param {String} message The message to display if the desired condition hasn't been met within the given time period. + * @param {jasmine.Spec} spec The Jasmine spec. + */ +jasmine.WaitsForBlock = function(env, timeout, latchFunction, message, spec) { + this.timeout = timeout || env.defaultTimeoutInterval; + this.latchFunction = latchFunction; + this.message = message; + this.totalTimeSpentWaitingForLatch = 0; + jasmine.Block.call(this, env, null, spec); +}; +jasmine.util.inherit(jasmine.WaitsForBlock, jasmine.Block); + +jasmine.WaitsForBlock.TIMEOUT_INCREMENT = 10; + +jasmine.WaitsForBlock.prototype.execute = function(onComplete) { + if (jasmine.VERBOSE) { + this.env.reporter.log('>> Jasmine waiting for ' + (this.message || 'something to happen')); + } + var latchFunctionResult; + try { + latchFunctionResult = this.latchFunction.apply(this.spec); + } catch (e) { + this.spec.fail(e); + onComplete(); + return; + } + + if (latchFunctionResult) { + onComplete(); + } else if (this.totalTimeSpentWaitingForLatch >= this.timeout) { + var message = 'timed out after ' + this.timeout + ' msec waiting for ' + (this.message || 'something to happen'); + this.spec.fail({ + name: 'timeout', + message: message + }); + + this.abort = true; + onComplete(); + } else { + this.totalTimeSpentWaitingForLatch += jasmine.WaitsForBlock.TIMEOUT_INCREMENT; + var self = this; + this.env.setTimeout(function() { + self.execute(onComplete); + }, jasmine.WaitsForBlock.TIMEOUT_INCREMENT); + } +}; + +jasmine.version_= { + "major": 1, + "minor": 2, + "build": 0, + "revision": 1333310630, + "release_candidate": 1 +}; diff --git a/spec/test-runner.js b/spec/test-runner.js new file mode 100644 index 00000000..f72b3cc5 --- /dev/null +++ b/spec/test-runner.js @@ -0,0 +1,62 @@ +/* + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * +*/ + +if (window.sessionStorage != null) { + window.sessionStorage.clear(); +} + +// Timeout is 2 seconds to allow physical devices enough +// time to query the response. This is important for some +// Android devices. +var Tests = function() {}; +Tests.TEST_TIMEOUT = 7500; + +// Creates a spy that will fail if called. +function createDoNotCallSpy(name, opt_extraMessage) { + return jasmine.createSpy().andCallFake(function() { + var errorMessage = name + ' should not have been called.'; + if (arguments.length) { + errorMessage += ' Got args: ' + JSON.stringify(arguments); + } + if (opt_extraMessage) { + errorMessage += '\n' + opt_extraMessage; + } + expect(false).toBe(true, errorMessage); + }); +} + +// Waits for any of the given spys to be called. +// Last param may be a custom timeout duration. +function waitsForAny() { + var spys = [].slice.call(arguments); + var timeout = Tests.TEST_TIMEOUT; + if (typeof spys[spys.length - 1] == 'number') { + timeout = spys.pop(); + } + waitsFor(function() { + for (var i = 0; i < spys.length; ++i) { + if (spys[i].wasCalled) { + return true; + } + } + return false; + }, "Expecting callbacks to be called.", timeout); +} diff --git a/src/android/com/plugin/android-support-v13.jar b/src/android/com/plugin/android-support-v13.jar new file mode 100644 index 00000000..57b70721 Binary files /dev/null and b/src/android/com/plugin/android-support-v13.jar differ diff --git a/src/android/com/plugin/gcm/CordovaGCMBroadcastReceiver.java b/src/android/com/plugin/gcm/CordovaGCMBroadcastReceiver.java new file mode 100644 index 00000000..e383f846 --- /dev/null +++ b/src/android/com/plugin/gcm/CordovaGCMBroadcastReceiver.java @@ -0,0 +1,19 @@ +package com.plugin.gcm; + +import android.content.Context; + +import com.google.android.gcm.GCMBroadcastReceiver; +import static com.google.android.gcm.GCMConstants.DEFAULT_INTENT_SERVICE_CLASS_NAME; + +/* + * Implementation of GCMBroadcastReceiver that hard-wires the intent service to be + * com.plugin.gcm.GCMIntentService, instead of your_package.GCMIntentService + */ +public class CordovaGCMBroadcastReceiver extends GCMBroadcastReceiver { + + @Override + protected String getGCMIntentServiceClassName(Context context) { + return "com.plugin.gcm" + DEFAULT_INTENT_SERVICE_CLASS_NAME; + } + +} \ No newline at end of file diff --git a/src/android/com/plugin/gcm/GCMIntentService.java b/src/android/com/plugin/gcm/GCMIntentService.java new file mode 100644 index 00000000..83143cdc --- /dev/null +++ b/src/android/com/plugin/gcm/GCMIntentService.java @@ -0,0 +1,221 @@ +package com.plugin.gcm; + + +import java.io.IOException; +import java.io.InputStream; +import java.net.HttpURLConnection; +import java.net.URL; + +import org.json.JSONException; +import org.json.JSONObject; + +import android.annotation.SuppressLint; +import android.app.Notification; +import android.app.NotificationManager; +import android.app.PendingIntent; +import android.content.Context; +import android.content.Intent; +import android.graphics.Bitmap; +import android.graphics.BitmapFactory; +import android.os.Bundle; +import android.support.v4.app.NotificationCompat; +import android.util.Log; + +import com.google.android.gcm.GCMBaseIntentService; + +@SuppressLint("NewApi") +public class GCMIntentService extends GCMBaseIntentService { + + public static final int NOTIFICATION_ID = 237; + private static final String TAG = "GCMIntentService"; + + public GCMIntentService() { + super("GCMIntentService"); + } + + @Override + public void onRegistered(Context context, String regId) { + + Log.v(TAG, "onRegistered: "+ regId); + + JSONObject json; + + try + { + json = new JSONObject().put("event", "registered"); + json.put("regid", regId); + + Log.v(TAG, "onRegistered: " + json.toString()); + + // Send this JSON data to the JavaScript application above EVENT should be set to the msg type + // In this case this is the registration ID + PushPlugin.sendJavascript( json ); + + } + catch( JSONException e) + { + // No message to the user is sent, JSON failed + Log.e(TAG, "onRegistered: JSON exception"); + } + } + + @Override + public void onUnregistered(Context context, String regId) { + Log.d(TAG, "onUnregistered - regId: " + regId); + } + + @Override + protected void onMessage(Context context, Intent intent) { + Log.d(TAG, "onMessage - context: " + context); + + // Extract the payload from the message + Bundle extras = intent.getExtras(); + if (extras != null) + { + + String cancelNotificationString = extras.getString("cancelNotification"); + + if (cancelNotificationString != null) + { + + Integer CurrentNotificationID=null; + String notIdOnMessage = extras.getString("notId"); + if (notIdOnMessage != null) { + CurrentNotificationID = Integer.parseInt(extras.getString("notId")); + } + else { + CurrentNotificationID=NOTIFICATION_ID; + } + + NotificationManager mNotificationManagerCancel = (NotificationManager) context.getSystemService(Context.NOTIFICATION_SERVICE); + mNotificationManagerCancel.cancel((String)getAppName(context), CurrentNotificationID); + } + + else + { + + // if we are in the foreground, just surface the payload, else post it to the statusbar + if (PushPlugin.isInForeground()) { + extras.putBoolean("foreground", true); + PushPlugin.sendExtras(extras); + } + else { + extras.putBoolean("foreground", false); + + // Send a notification if there is a message + if (extras.getString("message") != null && extras.getString("message").length() != 0) { + createNotification(context, extras); + } + + } + } + } + } + + public void createNotification(Context context, Bundle extras) + { + NotificationManager mNotificationManager = (NotificationManager) getSystemService(Context.NOTIFICATION_SERVICE); + String appName = getAppName(this); + + Intent notificationIntent = new Intent(this, PushHandlerActivity.class); + notificationIntent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP | Intent.FLAG_ACTIVITY_CLEAR_TOP); + notificationIntent.putExtra("pushBundle", extras); + + PendingIntent contentIntent = PendingIntent.getActivity(this, 0, notificationIntent, PendingIntent.FLAG_UPDATE_CURRENT); + + + + + Bitmap myBitmap = null; + String customIconUrl= null; + customIconUrl=extras.getString("icon"); + + try { + URL url = new URL(customIconUrl); + HttpURLConnection connection = (HttpURLConnection) url.openConnection(); + connection.setDoInput(true); + connection.connect(); + InputStream input = connection.getInputStream(); + myBitmap = BitmapFactory.decodeStream(input); + + } catch (IOException e) { + e.printStackTrace(); + + } + + + NotificationCompat.Builder mBuilder = + new NotificationCompat.Builder(context) + .setDefaults(Notification.DEFAULT_ALL) + .setSmallIcon(context.getApplicationInfo().icon) + .setLargeIcon(myBitmap) + .setWhen(System.currentTimeMillis()) + .setContentTitle(extras.getString("title")) + .setTicker(extras.getString("title")) + .setContentIntent(contentIntent) + .setAutoCancel(true); + + String message = extras.getString("message"); + if (message != null) { + mBuilder.setContentText(message); + } else { + mBuilder.setContentText(""); + } + + String msgcnt = extras.getString("msgcnt"); + if (msgcnt != null) { + mBuilder.setNumber(Integer.parseInt(msgcnt)); + } + + String messageBig = extras.getString("messageBig"); + if (msgcnt != null) { + mBuilder.setStyle(new NotificationCompat.BigTextStyle() + .bigText(messageBig)); + } + + + + + int notId = 0; + + try { + notId = Integer.parseInt(extras.getString("notId")); + } + catch(NumberFormatException e) { + Log.e(TAG, "Number format exception - Error parsing Notification ID: " + e.getMessage()); + } + catch(Exception e) { + Log.e(TAG, "Number format exception - Error parsing Notification ID" + e.getMessage()); + } + + + Notification notification = mBuilder.build(); + notification.defaults |= Notification.DEFAULT_VIBRATE; + notification.defaults |= Notification.DEFAULT_SOUND; + + notification.tickerText = extras.getString("title") + "\n" + messageBig; + + + mNotificationManager.notify((String) appName, notId, notification); + + } + + + + + private static String getAppName(Context context) + { + CharSequence appName = + context + .getPackageManager() + .getApplicationLabel(context.getApplicationInfo()); + + return (String)appName; + } + + @Override + public void onError(Context context, String errorId) { + Log.e(TAG, "onError - errorId: " + errorId); + } + +} diff --git a/src/android/com/plugin/gcm/PushHandlerActivity.java b/src/android/com/plugin/gcm/PushHandlerActivity.java new file mode 100644 index 00000000..6d19da1f --- /dev/null +++ b/src/android/com/plugin/gcm/PushHandlerActivity.java @@ -0,0 +1,63 @@ +package com.plugin.gcm; + +import android.app.Activity; +import android.content.Intent; +import android.content.pm.PackageManager; +import android.os.Bundle; +import android.util.Log; + +public class PushHandlerActivity extends Activity +{ + private static String TAG = "PushHandlerActivity"; + + /* + * this activity will be started if the user touches a notification that we own. + * We send it's data off to the push plugin for processing. + * If needed, we boot up the main activity to kickstart the application. + * @see android.app.Activity#onCreate(android.os.Bundle) + */ + @Override + public void onCreate(Bundle savedInstanceState) + { + super.onCreate(savedInstanceState); + Log.v(TAG, "onCreate"); + + boolean isPushPluginActive = PushPlugin.isActive(); + processPushBundle(isPushPluginActive); + + finish(); + + if (!isPushPluginActive) { + forceMainActivityReload(); + } + } + + /** + * Takes the pushBundle extras from the intent, + * and sends it through to the PushPlugin for processing. + */ + private void processPushBundle(boolean isPushPluginActive) + { + Bundle extras = getIntent().getExtras(); + + if (extras != null) { + Bundle originalExtras = extras.getBundle("pushBundle"); + + originalExtras.putBoolean("foreground", false); + originalExtras.putBoolean("coldstart", !isPushPluginActive); + + PushPlugin.sendExtras(originalExtras); + } + } + + /** + * Forces the main activity to re-launch if it's unloaded. + */ + private void forceMainActivityReload() + { + PackageManager pm = getPackageManager(); + Intent launchIntent = pm.getLaunchIntentForPackage(getApplicationContext().getPackageName()); + startActivity(launchIntent); + } + +} diff --git a/src/android/com/plugin/gcm/PushPlugin.java b/src/android/com/plugin/gcm/PushPlugin.java new file mode 100644 index 00000000..f5521cdf --- /dev/null +++ b/src/android/com/plugin/gcm/PushPlugin.java @@ -0,0 +1,245 @@ +package com.plugin.gcm; + +import java.util.Iterator; + +import org.json.JSONArray; +import org.json.JSONException; +import org.json.JSONObject; + +import android.content.Context; +import android.os.Bundle; +import android.util.Log; + +import org.apache.cordova.CordovaInterface; +import org.apache.cordova.CordovaWebView; +import org.apache.cordova.CallbackContext; +import org.apache.cordova.CordovaPlugin; + +import com.google.android.gcm.*; + +/** + * @author awysocki + */ + +public class PushPlugin extends CordovaPlugin { + public static final String TAG = "PushPlugin"; + + public static final String REGISTER = "register"; + public static final String UNREGISTER = "unregister"; + public static final String EXIT = "exit"; + + private static CordovaWebView gWebView; + private static String gECB; + private static String gSenderID; + private static Bundle gCachedExtras = null; + private static boolean gForeground = false; + + /** + * Gets the application context from cordova's main activity. + * @return the application context + */ + private Context getApplicationContext() { + return this.cordova.getActivity().getApplicationContext(); + } + + @Override + public boolean execute(String action, JSONArray data, CallbackContext callbackContext) { + + boolean result = false; + + Log.v(TAG, "execute: action=" + action); + + if (REGISTER.equals(action)) { + + Log.v(TAG, "execute: data=" + data.toString()); + + try { + JSONObject jo = data.getJSONObject(0); + + gWebView = this.webView; + Log.v(TAG, "execute: jo=" + jo.toString()); + + gECB = (String) jo.get("ecb"); + gSenderID = (String) jo.get("senderID"); + + Log.v(TAG, "execute: ECB=" + gECB + " senderID=" + gSenderID); + + GCMRegistrar.register(getApplicationContext(), gSenderID); + result = true; + callbackContext.success(); + } catch (JSONException e) { + Log.e(TAG, "execute: Got JSON Exception " + e.getMessage()); + result = false; + callbackContext.error(e.getMessage()); + } + + if ( gCachedExtras != null) { + Log.v(TAG, "sending cached extras"); + sendExtras(gCachedExtras); + gCachedExtras = null; + } + + } else if (UNREGISTER.equals(action)) { + + GCMRegistrar.unregister(getApplicationContext()); + + Log.v(TAG, "UNREGISTER"); + result = true; + callbackContext.success(); + } else { + result = false; + Log.e(TAG, "Invalid action : " + action); + callbackContext.error("Invalid action : " + action); + } + + return result; + } + + /* + * Sends a json object to the client as parameter to a method which is defined in gECB. + */ + public static void sendJavascript(JSONObject _json) { + String _d = "javascript:" + gECB + "(" + _json.toString() + ")"; + Log.v(TAG, "sendJavascript: " + _d); + + if (gECB != null && gWebView != null) { + gWebView.sendJavascript(_d); + } + } + + /* + * Sends the pushbundle extras to the client application. + * If the client application isn't currently active, it is cached for later processing. + */ + public static void sendExtras(Bundle extras) + { + if (extras != null) { + if (gECB != null && gWebView != null) { + sendJavascript(convertBundleToJson(extras)); + } else { + Log.v(TAG, "sendExtras: caching extras to send at a later time."); + gCachedExtras = extras; + } + } + } + + @Override + public void initialize(CordovaInterface cordova, CordovaWebView webView) { + super.initialize(cordova, webView); + gForeground = true; + } + + @Override + public void onPause(boolean multitasking) { + super.onPause(multitasking); + gForeground = false; + } + + @Override + public void onResume(boolean multitasking) { + super.onResume(multitasking); + gForeground = true; + } + + @Override + public void onDestroy() { + super.onDestroy(); + gForeground = false; + gECB = null; + gWebView = null; + } + + /* + * serializes a bundle to JSON. + */ + private static JSONObject convertBundleToJson(Bundle extras) + { + try + { + JSONObject json; + json = new JSONObject().put("event", "message"); + + JSONObject jsondata = new JSONObject(); + Iterator it = extras.keySet().iterator(); + while (it.hasNext()) + { + String key = it.next(); + Object value = extras.get(key); + + // System data from Android + if (key.equals("from") || key.equals("collapse_key")) + { + json.put(key, value); + } + else if (key.equals("foreground")) + { + json.put(key, extras.getBoolean("foreground")); + } + else if (key.equals("coldstart")) + { + json.put(key, extras.getBoolean("coldstart")); + } + else + { + // Maintain backwards compatibility + if (key.equals("message") || key.equals("msgcnt") || key.equals("soundname")) + { + json.put(key, value); + } + + if ( value instanceof String ) { + // Try to figure out if the value is another JSON object + + String strValue = (String)value; + if (strValue.startsWith("{")) { + try { + JSONObject json2 = new JSONObject(strValue); + jsondata.put(key, json2); + } + catch (Exception e) { + jsondata.put(key, value); + } + // Try to figure out if the value is another JSON array + } + else if (strValue.startsWith("[")) + { + try + { + JSONArray json2 = new JSONArray(strValue); + jsondata.put(key, json2); + } + catch (Exception e) + { + jsondata.put(key, value); + } + } + else + { + jsondata.put(key, value); + } + } + } + } // while + json.put("payload", jsondata); + + Log.v(TAG, "extrasToJSON: " + json.toString()); + + return json; + } + catch( JSONException e) + { + Log.e(TAG, "extrasToJSON: JSON exception"); + } + return null; + } + + public static boolean isInForeground() + { + return gForeground; + } + + public static boolean isActive() + { + return gWebView != null; + } +} diff --git a/src/android/gcm/GCMBaseIntentService.java b/src/android/gcm/GCMBaseIntentService.java deleted file mode 100644 index 95657654..00000000 --- a/src/android/gcm/GCMBaseIntentService.java +++ /dev/null @@ -1,299 +0,0 @@ -/* - * Copyright 2012 Google Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.google.android.gcm; - -import static com.google.android.gcm.GCMConstants.ERROR_SERVICE_NOT_AVAILABLE; -import static com.google.android.gcm.GCMConstants.EXTRA_ERROR; -import static com.google.android.gcm.GCMConstants.EXTRA_REGISTRATION_ID; -import static com.google.android.gcm.GCMConstants.EXTRA_SPECIAL_MESSAGE; -import static com.google.android.gcm.GCMConstants.EXTRA_TOTAL_DELETED; -import static com.google.android.gcm.GCMConstants.EXTRA_UNREGISTERED; -import static com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_LIBRARY_RETRY; -import static com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_MESSAGE; -import static com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK; -import static com.google.android.gcm.GCMConstants.VALUE_DELETED_MESSAGES; - -import android.app.AlarmManager; -import android.app.IntentService; -import android.app.PendingIntent; -import android.content.Context; -import android.content.Intent; -import android.os.PowerManager; -import android.os.SystemClock; -import android.util.Log; - -import java.util.Random; -import java.util.concurrent.TimeUnit; - -/** - * Skeleton for application-specific {@link IntentService}s responsible for - * handling communication from Google Cloud Messaging service. - *

    - * The abstract methods in this class are called from its worker thread, and - * hence should run in a limited amount of time. If they execute long - * operations, they should spawn new threads, otherwise the worker thread will - * be blocked. - */ -public abstract class GCMBaseIntentService extends IntentService { - - public static final String TAG = "GCMBaseIntentService"; - - // wakelock - private static final String WAKELOCK_KEY = "GCM_LIB"; - private static PowerManager.WakeLock sWakeLock; - - // Java lock used to synchronize access to sWakelock - private static final Object LOCK = GCMBaseIntentService.class; - - private final String mSenderId; - - // instance counter - private static int sCounter = 0; - - private static final Random sRandom = new Random(); - - private static final int MAX_BACKOFF_MS = - (int) TimeUnit.SECONDS.toMillis(3600); // 1 hour - - // token used to check intent origin - private static final String TOKEN = - Long.toBinaryString(sRandom.nextLong()); - private static final String EXTRA_TOKEN = "token"; - - /** - * Subclasses must create a public no-arg constructor and pass the - * sender id to be used for registration. - */ - protected GCMBaseIntentService(String senderId) { - // name is used as base name for threads, etc. - super("GCMIntentService-" + senderId + "-" + (++sCounter)); - mSenderId = senderId; - } - - /** - * Called when a cloud message has been received. - * - * @param context application's context. - * @param intent intent containing the message payload as extras. - */ - protected abstract void onMessage(Context context, Intent intent); - - /** - * Called when the GCM server tells pending messages have been deleted - * because the device was idle. - * - * @param context application's context. - * @param total total number of collapsed messages - */ - protected void onDeletedMessages(Context context, int total) { - } - - /** - * Called on a registration error that could be retried. - * - *

    By default, it does nothing and returns {@literal true}, but could be - * overridden to change that behavior and/or display the error. - * - * @param context application's context. - * @param errorId error id returned by the GCM service. - * - * @return if {@literal true}, failed operation will be retried (using - * exponential backoff). - */ - protected boolean onRecoverableError(Context context, String errorId) { - return true; - } - - /** - * Called on registration or unregistration error. - * - * @param context application's context. - * @param errorId error id returned by the GCM service. - */ - protected abstract void onError(Context context, String errorId); - - /** - * Called after a device has been registered. - * - * @param context application's context. - * @param registrationId the registration id returned by the GCM service. - */ - protected abstract void onRegistered(Context context, - String registrationId); - - /** - * Called after a device has been unregistered. - * - * @param registrationId the registration id that was previously registered. - * @param context application's context. - */ - protected abstract void onUnregistered(Context context, - String registrationId); - - @Override - public final void onHandleIntent(Intent intent) { - try { - Context context = getApplicationContext(); - String action = intent.getAction(); - if (action.equals(INTENT_FROM_GCM_REGISTRATION_CALLBACK)) { - handleRegistration(context, intent); - } else if (action.equals(INTENT_FROM_GCM_MESSAGE)) { - // checks for special messages - String messageType = - intent.getStringExtra(EXTRA_SPECIAL_MESSAGE); - if (messageType != null) { - if (messageType.equals(VALUE_DELETED_MESSAGES)) { - String sTotal = - intent.getStringExtra(EXTRA_TOTAL_DELETED); - if (sTotal != null) { - try { - int total = Integer.parseInt(sTotal); - Log.v(TAG, "Received deleted messages " + - "notification: " + total); - onDeletedMessages(context, total); - } catch (NumberFormatException e) { - Log.e(TAG, "GCM returned invalid number of " + - "deleted messages: " + sTotal); - } - } - } else { - // application is not using the latest GCM library - Log.e(TAG, "Received unknown special message: " + - messageType); - } - } else { - onMessage(context, intent); - } - } else if (action.equals(INTENT_FROM_GCM_LIBRARY_RETRY)) { - String token = intent.getStringExtra(EXTRA_TOKEN); - if (!TOKEN.equals(token)) { - // make sure intent was generated by this class, not by a - // malicious app. - Log.e(TAG, "Received invalid token: " + token); - return; - } - // retry last call - if (GCMRegistrar.isRegistered(context)) { - GCMRegistrar.internalUnregister(context); - } else { - GCMRegistrar.internalRegister(context, mSenderId); - } - } - } finally { - // Release the power lock, so phone can get back to sleep. - // The lock is reference-counted by default, so multiple - // messages are ok. - - // If onMessage() needs to spawn a thread or do something else, - // it should use its own lock. - synchronized (LOCK) { - // sanity check for null as this is a public method - if (sWakeLock != null) { - Log.v(TAG, "Releasing wakelock"); - sWakeLock.release(); - } else { - // should never happen during normal workflow - Log.e(TAG, "Wakelock reference is null"); - } - } - } - } - - /** - * Called from the broadcast receiver. - *

    - * Will process the received intent, call handleMessage(), registered(), - * etc. in background threads, with a wake lock, while keeping the service - * alive. - */ - static void runIntentInService(Context context, Intent intent, - String className) { - synchronized (LOCK) { - if (sWakeLock == null) { - // This is called from BroadcastReceiver, there is no init. - PowerManager pm = (PowerManager) - context.getSystemService(Context.POWER_SERVICE); - sWakeLock = pm.newWakeLock(PowerManager.PARTIAL_WAKE_LOCK, - WAKELOCK_KEY); - } - } - Log.v(TAG, "Acquiring wakelock"); - sWakeLock.acquire(); - intent.setClassName(context, className); - context.startService(intent); - } - - private void handleRegistration(final Context context, Intent intent) { - String registrationId = intent.getStringExtra(EXTRA_REGISTRATION_ID); - String error = intent.getStringExtra(EXTRA_ERROR); - String unregistered = intent.getStringExtra(EXTRA_UNREGISTERED); - Log.d(TAG, "handleRegistration: registrationId = " + registrationId + - ", error = " + error + ", unregistered = " + unregistered); - - // registration succeeded - if (registrationId != null) { - GCMRegistrar.resetBackoff(context); - GCMRegistrar.setRegistrationId(context, registrationId); - onRegistered(context, registrationId); - return; - } - - // unregistration succeeded - if (unregistered != null) { - // Remember we are unregistered - GCMRegistrar.resetBackoff(context); - String oldRegistrationId = - GCMRegistrar.clearRegistrationId(context); - onUnregistered(context, oldRegistrationId); - return; - } - - // last operation (registration or unregistration) returned an error; - Log.d(TAG, "Registration error: " + error); - // Registration failed - if (ERROR_SERVICE_NOT_AVAILABLE.equals(error)) { - boolean retry = onRecoverableError(context, error); - if (retry) { - int backoffTimeMs = GCMRegistrar.getBackoff(context); - int nextAttempt = backoffTimeMs / 2 + - sRandom.nextInt(backoffTimeMs); - Log.d(TAG, "Scheduling registration retry, backoff = " + - nextAttempt + " (" + backoffTimeMs + ")"); - Intent retryIntent = - new Intent(INTENT_FROM_GCM_LIBRARY_RETRY); - retryIntent.putExtra(EXTRA_TOKEN, TOKEN); - PendingIntent retryPendingIntent = PendingIntent - .getBroadcast(context, 0, retryIntent, 0); - AlarmManager am = (AlarmManager) - context.getSystemService(Context.ALARM_SERVICE); - am.set(AlarmManager.ELAPSED_REALTIME, - SystemClock.elapsedRealtime() + nextAttempt, - retryPendingIntent); - // Next retry should wait longer. - if (backoffTimeMs < MAX_BACKOFF_MS) { - GCMRegistrar.setBackoff(context, backoffTimeMs * 2); - } - } else { - Log.d(TAG, "Not retrying failed operation"); - } - } else { - // Unrecoverable error, notify app - onError(context, error); - } - } - -} diff --git a/src/android/gcm/GCMBroadcastReceiver.java b/src/android/gcm/GCMBroadcastReceiver.java deleted file mode 100644 index 6e9b7ebb..00000000 --- a/src/android/gcm/GCMBroadcastReceiver.java +++ /dev/null @@ -1,57 +0,0 @@ -/* - * Copyright 2012 Google Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.google.android.gcm; - -import static com.google.android.gcm.GCMConstants.DEFAULT_INTENT_SERVICE_CLASS_NAME; - -import android.app.Activity; -import android.content.BroadcastReceiver; -import android.content.Context; -import android.content.Intent; -import android.util.Log; - -/** - * {@link BroadcastReceiver} that receives GCM messages and delivers them to - * an application-specific {@link GCMBaseIntentService} subclass. - *

    - * By default, the {@link GCMBaseIntentService} class belongs to the application - * main package and is named - * {@link GCMConstants#DEFAULT_INTENT_SERVICE_CLASS_NAME}. To use a new class, - * the {@link #getGCMIntentServiceClassName(Context)} must be overridden. - */ -public class GCMBroadcastReceiver extends BroadcastReceiver { - - private static final String TAG = "GCMBroadcastReceiver"; - - @Override - public final void onReceive(Context context, Intent intent) { - Log.v(TAG, "onReceive: " + intent.getAction()); - String className = getGCMIntentServiceClassName(context); - Log.v(TAG, "GCM IntentService class: " + className); - // Delegates to the application-specific intent service. - GCMBaseIntentService.runIntentInService(context, intent, className); - setResult(Activity.RESULT_OK, null /* data */, null /* extra */); - } - - /** - * Gets the class name of the intent service that will handle GCM messages. - */ - protected String getGCMIntentServiceClassName(Context context) { - return "com.google.android.gcm" + DEFAULT_INTENT_SERVICE_CLASS_NAME; - } - -} diff --git a/src/android/gcm/GCMConstants.java b/src/android/gcm/GCMConstants.java deleted file mode 100644 index abcdcfb0..00000000 --- a/src/android/gcm/GCMConstants.java +++ /dev/null @@ -1,161 +0,0 @@ -/* - * Copyright 2012 Google Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.google.android.gcm; - -/** - * Constants used by the GCM library. - */ -public final class GCMConstants { - - /** - * Intent sent to GCM to register the application. - */ - public static final String INTENT_TO_GCM_REGISTRATION = - "com.google.android.c2dm.intent.REGISTER"; - - /** - * Intent sent to GCM to unregister the application. - */ - public static final String INTENT_TO_GCM_UNREGISTRATION = - "com.google.android.c2dm.intent.UNREGISTER"; - - /** - * Intent sent by GCM indicating with the result of a registration request. - */ - public static final String INTENT_FROM_GCM_REGISTRATION_CALLBACK = - "com.google.android.c2dm.intent.REGISTRATION"; - - /** - * Intent used by the GCM library to indicate that the registration call - * should be retried. - */ - public static final String INTENT_FROM_GCM_LIBRARY_RETRY = - "com.google.android.gcm.intent.RETRY"; - - /** - * Intent sent by GCM containing a message. - */ - public static final String INTENT_FROM_GCM_MESSAGE = - "com.google.android.c2dm.intent.RECEIVE"; - - /** - * Extra used on {@link #INTENT_TO_GCM_REGISTRATION} to indicate the sender - * account (a Google email) that owns the application. - */ - public static final String EXTRA_SENDER = "sender"; - - /** - * Extra used on {@link #INTENT_TO_GCM_REGISTRATION} to get the application - * id. - */ - public static final String EXTRA_APPLICATION_PENDING_INTENT = "app"; - - /** - * Extra used on {@link #INTENT_FROM_GCM_REGISTRATION_CALLBACK} to indicate - * that the application has been unregistered. - */ - public static final String EXTRA_UNREGISTERED = "unregistered"; - - /** - * Extra used on {@link #INTENT_FROM_GCM_REGISTRATION_CALLBACK} to indicate - * an error when the registration fails. See constants starting with ERROR_ - * for possible values. - */ - public static final String EXTRA_ERROR = "error"; - - /** - * Extra used on {@link #INTENT_FROM_GCM_REGISTRATION_CALLBACK} to indicate - * the registration id when the registration succeeds. - */ - public static final String EXTRA_REGISTRATION_ID = "registration_id"; - - /** - * Type of message present in the {@link #INTENT_FROM_GCM_MESSAGE} intent. - * This extra is only set for special messages sent from GCM, not for - * messages originated from the application. - */ - public static final String EXTRA_SPECIAL_MESSAGE = "message_type"; - - /** - * Special message indicating the server deleted the pending messages. - */ - public static final String VALUE_DELETED_MESSAGES = "deleted_messages"; - - /** - * Number of messages deleted by the server because the device was idle. - * Present only on messages of special type - * {@link #VALUE_DELETED_MESSAGES} - */ - public static final String EXTRA_TOTAL_DELETED = "total_deleted"; - - /** - * Permission necessary to receive GCM intents. - */ - public static final String PERMISSION_GCM_INTENTS = - "com.google.android.c2dm.permission.SEND"; - - /** - * @see GCMBroadcastReceiver - */ - public static final String DEFAULT_INTENT_SERVICE_CLASS_NAME = - ".GCMIntentService"; - - /** - * The device can't read the response, or there was a 500/503 from the - * server that can be retried later. The application should use exponential - * back off and retry. - */ - public static final String ERROR_SERVICE_NOT_AVAILABLE = - "SERVICE_NOT_AVAILABLE"; - - /** - * There is no Google account on the phone. The application should ask the - * user to open the account manager and add a Google account. - */ - public static final String ERROR_ACCOUNT_MISSING = - "ACCOUNT_MISSING"; - - /** - * Bad password. The application should ask the user to enter his/her - * password, and let user retry manually later. Fix on the device side. - */ - public static final String ERROR_AUTHENTICATION_FAILED = - "AUTHENTICATION_FAILED"; - - /** - * The request sent by the phone does not contain the expected parameters. - * This phone doesn't currently support GCM. - */ - public static final String ERROR_INVALID_PARAMETERS = - "INVALID_PARAMETERS"; - /** - * The sender account is not recognized. Fix on the device side. - */ - public static final String ERROR_INVALID_SENDER = - "INVALID_SENDER"; - - /** - * Incorrect phone registration with Google. This phone doesn't currently - * support GCM. - */ - public static final String ERROR_PHONE_REGISTRATION_ERROR = - "PHONE_REGISTRATION_ERROR"; - - private GCMConstants() { - throw new UnsupportedOperationException(); - } -} diff --git a/src/android/gcm/GCMIntentService.java b/src/android/gcm/GCMIntentService.java deleted file mode 100644 index 79a13ca0..00000000 --- a/src/android/gcm/GCMIntentService.java +++ /dev/null @@ -1,95 +0,0 @@ -package com.google.android.gcm; - -import com.google.android.gcm.*; -import org.json.JSONException; -import org.json.JSONObject; -import android.content.Context; -import android.content.Intent; -import android.os.Bundle; -import android.util.Log; -import com.plugin.GCM.PushPlugin; - - -public class GCMIntentService extends GCMBaseIntentService { - - public static final String ME="GCMReceiver"; - - public GCMIntentService() { - super("GCMIntentService"); - } - private static final String TAG = "GCMIntentService"; - - @Override - public void onRegistered(Context context, String regId) { - - Log.v(ME + ":onRegistered", "Registration ID arrived!"); - Log.v(ME + ":onRegistered", regId); - - JSONObject json; - - try - { - json = new JSONObject().put("event", "registered"); - json.put("regid", regId); - - Log.v(ME + ":onRegisterd", json.toString()); - - // Send this JSON data to the JavaScript application above EVENT should be set to the msg type - // In this case this is the registration ID - PushPlugin.sendJavascript( json ); - - } - catch( JSONException e) - { - // No message to the user is sent, JSON failed - Log.e(ME + ":onRegisterd", "JSON exception"); - } - } - - @Override - public void onUnregistered(Context context, String regId) { - Log.d(TAG, "onUnregistered - regId: " + regId); - } - - @Override - protected void onMessage(Context context, Intent intent) { - Log.d(TAG, "onMessage - context: " + context); - - // Extract the payload from the message - Bundle extras = intent.getExtras(); - if (extras != null) { - try - { - JSONObject json; - json = new JSONObject().put("event", "message"); - - - // My application on my host server sends back to "EXTRAS" variables message and msgcnt - // Depending on how you build your server app you can specify what variables you want to send - // - json.put("message", extras.getString("message")); - json.put("msgcnt", extras.getString("msgcnt")); - - Log.v(ME + ":onMessage ", json.toString()); - - PushPlugin.sendJavascript( json ); - // Send the MESSAGE to the Javascript application - } - catch( JSONException e) - { - Log.e(ME + ":onMessage", "JSON exception"); - } - } - - - } - - @Override - public void onError(Context context, String errorId) { - Log.e(TAG, "onError - errorId: " + errorId); - } - - - - -} diff --git a/src/android/gcm/GCMRegistrar.java b/src/android/gcm/GCMRegistrar.java deleted file mode 100644 index 61ab8f91..00000000 --- a/src/android/gcm/GCMRegistrar.java +++ /dev/null @@ -1,421 +0,0 @@ -/* - * Copyright 2012 Google Inc. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.google.android.gcm; - -import android.app.PendingIntent; -import android.content.BroadcastReceiver; -import android.content.Context; -import android.content.Intent; -import android.content.IntentFilter; -import android.content.SharedPreferences; -import android.content.SharedPreferences.Editor; -import android.content.pm.ActivityInfo; -import android.content.pm.PackageInfo; -import android.content.pm.PackageManager; -import android.content.pm.PackageManager.NameNotFoundException; -import android.content.pm.ResolveInfo; -import android.os.Build; -import android.util.Log; - -import java.util.HashSet; -import java.util.List; -import java.util.Set; - -/** - * Utilities for device registration. - *

    - * Note: this class uses a private {@link SharedPreferences} - * object to keep track of the registration token. - */ -public final class GCMRegistrar { - - private static final String TAG = "GCMRegistrar"; - private static final String BACKOFF_MS = "backoff_ms"; - private static final String GSF_PACKAGE = "com.google.android.gsf"; - private static final String PREFERENCES = "com.google.android.gcm"; - private static final int DEFAULT_BACKOFF_MS = 3000; - private static final String PROPERTY_REG_ID = "regId"; - private static final String PROPERTY_APP_VERSION = "appVersion"; - private static final String PROPERTY_ON_SERVER = "onServer"; - - /** - * {@link GCMBroadcastReceiver} instance used to handle the retry intent. - * - *

    - * This instance cannot be the same as the one defined in the manifest - * because it needs a different permission. - */ - private static GCMBroadcastReceiver sRetryReceiver; - - /** - * Checks if the device has the proper dependencies installed. - *

    - * This method should be called when the application starts to verify that - * the device supports GCM. - * - * @param context application context. - * @throws UnsupportedOperationException if the device does not support GCM. - */ - public static void checkDevice(Context context) { - int version = Build.VERSION.SDK_INT; - if (version < 8) { - throw new UnsupportedOperationException("Device must be at least " + - "API Level 8 (instead of " + version + ")"); - } - PackageManager packageManager = context.getPackageManager(); - try { - packageManager.getPackageInfo(GSF_PACKAGE, 0); - } catch (NameNotFoundException e) { - throw new UnsupportedOperationException( - "Device does not have package " + GSF_PACKAGE); - } - } - - /** - * Checks that the application manifest is properly configured. - *

    - * A proper configuration means: - *

      - *
    1. It creates a custom permission called - * {@code PACKAGE_NAME.permission.C2D_MESSAGE}. - *
    2. It defines at least one {@link BroadcastReceiver} with category - * {@code PACKAGE_NAME}. - *
    3. The {@link BroadcastReceiver}(s) uses the - * {@value GCMConstants#PERMISSION_GCM_INTENTS} permission. - *
    4. The {@link BroadcastReceiver}(s) handles the 3 GCM intents - * ({@value GCMConstants#INTENT_FROM_GCM_MESSAGE}, - * {@value GCMConstants#INTENT_FROM_GCM_REGISTRATION_CALLBACK}, - * and {@value GCMConstants#INTENT_FROM_GCM_LIBRARY_RETRY}). - *
    - * ...where {@code PACKAGE_NAME} is the application package. - *

    - * This method should be used during development time to verify that the - * manifest is properly set up, but it doesn't need to be called once the - * application is deployed to the users' devices. - * - * @param context application context. - * @throws IllegalStateException if any of the conditions above is not met. - */ - public static void checkManifest(Context context) { - PackageManager packageManager = context.getPackageManager(); - String packageName = context.getPackageName(); - String permissionName = packageName + ".permission.C2D_MESSAGE"; - // check permission - try { - packageManager.getPermissionInfo(permissionName, - PackageManager.GET_PERMISSIONS); - } catch (NameNotFoundException e) { - throw new IllegalStateException( - "Application does not define permission " + permissionName); - } - // check receivers - PackageInfo receiversInfo; - try { - receiversInfo = packageManager.getPackageInfo( - packageName, PackageManager.GET_RECEIVERS); - } catch (NameNotFoundException e) { - throw new IllegalStateException( - "Could not get receivers for package " + packageName); - } - ActivityInfo[] receivers = receiversInfo.receivers; - if (receivers == null || receivers.length == 0) { - throw new IllegalStateException("No receiver for package " + - packageName); - } - if (Log.isLoggable(TAG, Log.VERBOSE)) { - Log.v(TAG, "number of receivers for " + packageName + ": " + - receivers.length); - } - Set allowedReceivers = new HashSet(); - for (ActivityInfo receiver : receivers) { - if (GCMConstants.PERMISSION_GCM_INTENTS.equals( - receiver.permission)) { - allowedReceivers.add(receiver.name); - } - } - if (allowedReceivers.isEmpty()) { - throw new IllegalStateException("No receiver allowed to receive " + - GCMConstants.PERMISSION_GCM_INTENTS); - } - checkReceiver(context, allowedReceivers, - GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK); - checkReceiver(context, allowedReceivers, - GCMConstants.INTENT_FROM_GCM_MESSAGE); - } - - private static void checkReceiver(Context context, - Set allowedReceivers, String action) { - PackageManager pm = context.getPackageManager(); - String packageName = context.getPackageName(); - Intent intent = new Intent(action); - intent.setPackage(packageName); - List receivers = pm.queryBroadcastReceivers(intent, - PackageManager.GET_INTENT_FILTERS); - if (receivers.isEmpty()) { - throw new IllegalStateException("No receivers for action " + - action); - } - if (Log.isLoggable(TAG, Log.VERBOSE)) { - Log.v(TAG, "Found " + receivers.size() + " receivers for action " + - action); - } - // make sure receivers match - for (ResolveInfo receiver : receivers) { - String name = receiver.activityInfo.name; - if (! allowedReceivers.contains(name)) { - throw new IllegalStateException("Receiver " + name + - " is not set with permission " + - GCMConstants.PERMISSION_GCM_INTENTS); - } - } - } - - /** - * Initiate messaging registration for the current application. - *

    - * The result will be returned as an - * {@link GCMConstants#INTENT_FROM_GCM_REGISTRATION_CALLBACK} intent with - * either a {@link GCMConstants#EXTRA_REGISTRATION_ID} or - * {@link GCMConstants#EXTRA_ERROR}. - * - * @param context application context. - * @param senderIds Google Project ID of the accounts authorized to send - * messages to this application. - * @throws IllegalStateException if device does not have all GCM - * dependencies installed. - */ - public static void register(Context context, String... senderIds) { - setRetryBroadcastReceiver(context); - GCMRegistrar.resetBackoff(context); - internalRegister(context, senderIds); - } - - static void internalRegister(Context context, String... senderIds) { - if (senderIds == null || senderIds.length == 0 ) { - throw new IllegalArgumentException("No senderIds"); - } - StringBuilder builder = new StringBuilder(senderIds[0]); - for (int i = 1; i < senderIds.length; i++) { - builder.append(',').append(senderIds[i]); - } - String senders = builder.toString(); - Log.v(TAG, "Registering app " + context.getPackageName() + - " of senders " + senders); - Intent intent = new Intent(GCMConstants.INTENT_TO_GCM_REGISTRATION); - intent.setPackage(GSF_PACKAGE); - intent.putExtra(GCMConstants.EXTRA_APPLICATION_PENDING_INTENT, - PendingIntent.getBroadcast(context, 0, new Intent(), 0)); - intent.putExtra(GCMConstants.EXTRA_SENDER, senders); - context.startService(intent); - } - - /** - * Unregister the application. - *

    - * The result will be returned as an - * {@link GCMConstants#INTENT_FROM_GCM_REGISTRATION_CALLBACK} intent with an - * {@link GCMConstants#EXTRA_UNREGISTERED} extra. - */ - public static void unregister(Context context) { - setRetryBroadcastReceiver(context); - GCMRegistrar.resetBackoff(context); - internalUnregister(context); - } - - /** - * Clear internal resources. - * - *

    - * This method should be called by the main activity's {@code onDestroy()} - * method. - */ - public static synchronized void onDestroy(Context context) { - if (sRetryReceiver != null) { - Log.v(TAG, "Unregistering receiver"); - context.unregisterReceiver(sRetryReceiver); - sRetryReceiver = null; - } - } - - static void internalUnregister(Context context) { - Log.v(TAG, "Unregistering app " + context.getPackageName() ); - Intent intent = new Intent(GCMConstants.INTENT_TO_GCM_UNREGISTRATION); - intent.setPackage(GSF_PACKAGE); - intent.putExtra(GCMConstants.EXTRA_APPLICATION_PENDING_INTENT, - PendingIntent.getBroadcast(context, 0, new Intent(), 0)); - context.startService(intent); - } - - /** - * Lazy initializes the {@link GCMBroadcastReceiver} instance. - */ - private static synchronized void setRetryBroadcastReceiver(Context context) { - if (sRetryReceiver == null) { - sRetryReceiver = new GCMBroadcastReceiver(); - String category = context.getPackageName(); - IntentFilter filter = new IntentFilter( - GCMConstants.INTENT_FROM_GCM_LIBRARY_RETRY); - filter.addCategory(category); - // must use a permission that is defined on manifest for sure - String permission = category + ".permission.C2D_MESSAGE"; - Log.v(TAG, "Registering receiver"); - context.registerReceiver(sRetryReceiver, filter, permission, null); - } - } - - /** - * Gets the current registration id for application on GCM service. - *

    - * If result is empty, the registration has failed. - * - * @return registration id, or empty string if the registration is not - * complete. - */ - public static String getRegistrationId(Context context) { - final SharedPreferences prefs = getGCMPreferences(context); - String registrationId = prefs.getString(PROPERTY_REG_ID, ""); - // check if app was updated; if so, it must clear registration id to - // avoid a race condition if GCM sends a message - int oldVersion = prefs.getInt(PROPERTY_APP_VERSION, Integer.MIN_VALUE); - int newVersion = getAppVersion(context); - if (oldVersion != Integer.MIN_VALUE && oldVersion != newVersion) { - Log.v(TAG, "App version changed from " + oldVersion + " to " + - newVersion + "; resetting registration id"); - clearRegistrationId(context); - registrationId = ""; - } - return registrationId; - } - - /** - * Checks whether the application was successfully registered on GCM - * service. - */ - public static boolean isRegistered(Context context) { - return getRegistrationId(context).length() > 0; - } - - /** - * Clears the registration id in the persistence store. - * - * @param context application's context. - * @return old registration id. - */ - static String clearRegistrationId(Context context) { - return setRegistrationId(context, ""); - } - - /** - * Sets the registration id in the persistence store. - * - * @param context application's context. - * @param regId registration id - */ - static String setRegistrationId(Context context, String regId) { - final SharedPreferences prefs = getGCMPreferences(context); - String oldRegistrationId = prefs.getString(PROPERTY_REG_ID, ""); - int appVersion = getAppVersion(context); - Log.v(TAG, "Saving regId on app version " + appVersion); - Editor editor = prefs.edit(); - editor.putString(PROPERTY_REG_ID, regId); - editor.putInt(PROPERTY_APP_VERSION, appVersion); - editor.commit(); - return oldRegistrationId; - } - - /** - * Sets whether the device was successfully registered in the server side. - */ - public static void setRegisteredOnServer(Context context, boolean flag) { - final SharedPreferences prefs = getGCMPreferences(context); - Log.v(TAG, "Setting registered on server status as: " + flag); - Editor editor = prefs.edit(); - editor.putBoolean(PROPERTY_ON_SERVER, flag); - editor.commit(); - } - - /** - * Checks whether the device was successfully registered in the server side. - */ - public static boolean isRegisteredOnServer(Context context) { - final SharedPreferences prefs = getGCMPreferences(context); - boolean isRegistered = prefs.getBoolean(PROPERTY_ON_SERVER, false); - Log.v(TAG, "Is registered on server: " + isRegistered); - return isRegistered; - } - - /** - * Gets the application version. - */ - private static int getAppVersion(Context context) { - try { - PackageInfo packageInfo = context.getPackageManager() - .getPackageInfo(context.getPackageName(),0); - return packageInfo.versionCode; - } catch (NameNotFoundException e) { - // should never happen - throw new RuntimeException("Coult not get package name: " + e); - } - } - - /** - * Resets the backoff counter. - *

    - * This method should be called after a GCM call succeeds. - * - * @param context application's context. - */ - static void resetBackoff(Context context) { - Log.d(TAG, "resetting backoff for " + context.getPackageName()); - setBackoff(context, DEFAULT_BACKOFF_MS); - } - - /** - * Gets the current backoff counter. - * - * @param context application's context. - * @return current backoff counter, in milliseconds. - */ - static int getBackoff(Context context) { - final SharedPreferences prefs = getGCMPreferences(context); - return prefs.getInt(BACKOFF_MS, DEFAULT_BACKOFF_MS); - } - - /** - * Sets the backoff counter. - *

    - * This method should be called after a GCM call fails, passing an - * exponential value. - * - * @param context application's context. - * @param backoff new backoff counter, in milliseconds. - */ - static void setBackoff(Context context, int backoff) { - final SharedPreferences prefs = getGCMPreferences(context); - Editor editor = prefs.edit(); - editor.putInt(BACKOFF_MS, backoff); - editor.commit(); - } - - private static SharedPreferences getGCMPreferences(Context context) { - return context.getSharedPreferences(PREFERENCES, Context.MODE_PRIVATE); - } - - private GCMRegistrar() { - throw new UnsupportedOperationException(); - } -} diff --git a/src/android/libs/gcm.jar b/src/android/libs/gcm.jar new file mode 100644 index 00000000..ac109a83 Binary files /dev/null and b/src/android/libs/gcm.jar differ diff --git a/src/android/plugin/PushPlugin.java b/src/android/plugin/PushPlugin.java deleted file mode 100644 index ec8aaa69..00000000 --- a/src/android/plugin/PushPlugin.java +++ /dev/null @@ -1,110 +0,0 @@ -package com.plugin.GCM; - - -//import java.io.*; -//import java.util.*; - - -import org.json.JSONArray; -import org.json.JSONException; -import org.json.JSONObject; - -import android.util.Log; - -import org.apache.cordova.api.Plugin; -import org.apache.cordova.api.PluginResult; -import org.apache.cordova.api.PluginResult.Status; -import com.google.android.gcm.*; - - -/** - * @author awysocki - * - */ - -public class PushPlugin extends Plugin { - - public static final String ME="PushPlugin"; - - public static final String REGISTER="register"; - public static final String UNREGISTER="unregister"; - - public static Plugin gwebView; - private static String gECB; - private static String gSenderID; - - @SuppressWarnings("deprecation") -@Override - public PluginResult execute(String action, JSONArray data, String callbackId) - { - - PluginResult result = null; - - Log.v(ME + ":execute", "action=" + action); - - if (REGISTER.equals(action)) { - - Log.v(ME + ":execute", "data=" + data.toString()); - - try { - - JSONObject jo= new JSONObject(data.toString().substring(1, data.toString().length()-1)); - - gwebView = this; - - Log.v(ME + ":execute", "jo=" + jo.toString()); - - gECB = (String)jo.get("ecb"); - gSenderID = (String)jo.get("senderID"); - - Log.v(ME + ":execute", "ECB="+gECB+" senderID="+gSenderID ); - - GCMRegistrar.register(this.ctx.getContext(), gSenderID); - - - Log.v(ME + ":execute", "GCMRegistrar.register called "); - - result = new PluginResult(Status.OK); - } - catch (JSONException e) { - Log.e(ME, "Got JSON Exception " - + e.getMessage()); - result = new PluginResult(Status.JSON_EXCEPTION); - } - } - else if (UNREGISTER.equals(action)) { - - GCMRegistrar.unregister(this.ctx.getContext()); - Log.v(ME + ":" + UNREGISTER, "GCMRegistrar.unregister called "); - - } - else - { - result = new PluginResult(Status.INVALID_ACTION); - Log.e(ME, "Invalid action : "+action); - } - - return result; - } - - - public static void sendJavascript( JSONObject _json ) - { - String _d = "javascript:"+gECB+"(" + _json.toString() + ")"; - Log.v(ME + ":sendJavascript", _d); - - if (gECB != null ) { - gwebView.sendJavascript( _d ); - } - } - - - /** - * Gets the Directory listing for file, in JSON format - * @param file The file for which we want to do directory listing - * @return JSONObject representation of directory list. e.g {"filename":"/sdcard","isdir":true,"children":[{"filename":"a.txt","isdir":false},{..}]} - * @throws JSONException - */ - - -} diff --git a/src/ios/AppDelegate+notification.m b/src/ios/AppDelegate+notification.m index 78eb1556..5859f191 100644 --- a/src/ios/AppDelegate+notification.m +++ b/src/ios/AppDelegate+notification.m @@ -19,6 +19,39 @@ - (id) getCommandInstance:(NSString*)className return [self.viewController getCommandInstance:className]; } +// its dangerous to override a method from within a category. +// Instead we will use method swizzling. we set this up in the load call. ++ (void)load +{ + Method original, swizzled; + + original = class_getInstanceMethod(self, @selector(init)); + swizzled = class_getInstanceMethod(self, @selector(swizzled_init)); + method_exchangeImplementations(original, swizzled); +} + +- (AppDelegate *)swizzled_init +{ + [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(createNotificationChecker:) + name:@"UIApplicationDidFinishLaunchingNotification" object:nil]; + + // This actually calls the original init method over in AppDelegate. Equivilent to calling super + // on an overrided method, this is not recursive, although it appears that way. neat huh? + return [self swizzled_init]; +} + +// This code will be called immediately after application:didFinishLaunchingWithOptions:. We need +// to process notifications in cold-start situations +- (void)createNotificationChecker:(NSNotification *)notification +{ + if (notification) + { + NSDictionary *launchOptions = [notification userInfo]; + if (launchOptions) + self.launchNotification = [launchOptions objectForKey: @"UIApplicationLaunchOptionsRemoteNotificationKey"]; + } +} + - (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken { PushPlugin *pushHandler = [self getCommandInstance:@"PushPlugin"]; [pushHandler didRegisterForRemoteNotificationsWithDeviceToken:deviceToken]; @@ -40,7 +73,8 @@ - (void)application:(UIApplication *)application didReceiveRemoteNotification:(N if (appState == UIApplicationStateActive) { PushPlugin *pushHandler = [self getCommandInstance:@"PushPlugin"]; - pushHandler.notificationMessage = [userInfo objectForKey:@"aps"]; + pushHandler.notificationMessage = userInfo; + pushHandler.isInline = YES; [pushHandler notificationReceived]; } else { //save it for later @@ -57,10 +91,9 @@ - (void)applicationDidBecomeActive:(UIApplication *)application { if (![self.viewController.webView isLoading] && self.launchNotification) { PushPlugin *pushHandler = [self getCommandInstance:@"PushPlugin"]; - pushHandler.notificationMessage = [self.launchNotification objectForKey:@"aps"]; - + + pushHandler.notificationMessage = self.launchNotification; self.launchNotification = nil; - [pushHandler performSelectorOnMainThread:@selector(notificationReceived) withObject:pushHandler waitUntilDone:NO]; } } @@ -80,7 +113,6 @@ - (void)setLaunchNotification:(NSDictionary *)aDictionary - (void)dealloc { self.launchNotification = nil; // clear the association and release the object - [super dealloc]; } @end diff --git a/src/ios/PushPlugin.h b/src/ios/PushPlugin.h index ef82acdf..7e7ba4bc 100644 --- a/src/ios/PushPlugin.h +++ b/src/ios/PushPlugin.h @@ -25,10 +25,12 @@ #import #import +#import @interface PushPlugin : CDVPlugin { NSDictionary *notificationMessage; + BOOL isInline; NSString *notificationCallbackId; NSString *callback; @@ -39,9 +41,10 @@ @property (nonatomic, copy) NSString *notificationCallbackId; @property (nonatomic, copy) NSString *callback; -@property (nonatomic, retain) NSDictionary *notificationMessage; +@property (nonatomic, strong) NSDictionary *notificationMessage; +@property BOOL isInline; -- (void)register:(NSMutableArray *)arguments withDict:(NSMutableDictionary *)options; +- (void)register:(CDVInvokedUrlCommand*)command; - (void)didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken; - (void)didFailToRegisterForRemoteNotificationsWithError:(NSError *)error; diff --git a/src/ios/PushPlugin.m b/src/ios/PushPlugin.m index af1096e1..9c29d569 100644 --- a/src/ios/PushPlugin.m +++ b/src/ios/PushPlugin.m @@ -28,41 +28,54 @@ @implementation PushPlugin @synthesize notificationMessage; +@synthesize isInline; @synthesize callbackId; @synthesize notificationCallbackId; @synthesize callback; -- (void)dealloc -{ - [notificationMessage release]; - self.notificationCallbackId = nil; - self.callback = nil; - - [super dealloc]; -} -- (void)unregister:(NSMutableArray *)arguments withDict:(NSMutableDictionary *)options +- (void)unregister:(CDVInvokedUrlCommand*)command; { - self.callbackId = [arguments pop]; + self.callbackId = command.callbackId; [[UIApplication sharedApplication] unregisterForRemoteNotifications]; [self successWithMessage:@"unregistered"]; } -- (void)register:(NSMutableArray *)arguments withDict:(NSMutableDictionary *)options +- (void)register:(CDVInvokedUrlCommand*)command; { - self.callbackId = [arguments pop]; + self.callbackId = command.callbackId; + + NSMutableDictionary* options = [command.arguments objectAtIndex:0]; UIRemoteNotificationType notificationTypes = UIRemoteNotificationTypeNone; + id badgeArg = [options objectForKey:@"badge"]; + id soundArg = [options objectForKey:@"sound"]; + id alertArg = [options objectForKey:@"alert"]; - if ([[options objectForKey:@"badge"] isEqualToString:@"true"]) + if ([badgeArg isKindOfClass:[NSString class]]) + { + if ([badgeArg isEqualToString:@"true"]) + notificationTypes |= UIRemoteNotificationTypeBadge; + } + else if ([badgeArg boolValue]) notificationTypes |= UIRemoteNotificationTypeBadge; - - if ([[options objectForKey:@"sound"] isEqualToString:@"true"]) + + if ([soundArg isKindOfClass:[NSString class]]) + { + if ([soundArg isEqualToString:@"true"]) + notificationTypes |= UIRemoteNotificationTypeSound; + } + else if ([soundArg boolValue]) notificationTypes |= UIRemoteNotificationTypeSound; - - if ([[options objectForKey:@"alert"] isEqualToString:@"true"]) + + if ([alertArg isKindOfClass:[NSString class]]) + { + if ([alertArg isEqualToString:@"true"]) + notificationTypes |= UIRemoteNotificationTypeAlert; + } + else if ([alertArg boolValue]) notificationTypes |= UIRemoteNotificationTypeAlert; self.callback = [options objectForKey:@"ecb"]; @@ -70,14 +83,21 @@ - (void)register:(NSMutableArray *)arguments withDict:(NSMutableDictionary *)opt if (notificationTypes == UIRemoteNotificationTypeNone) NSLog(@"PushPlugin.register: Push notification type is set to none"); + isInline = NO; + [[UIApplication sharedApplication] registerForRemoteNotificationTypes:notificationTypes]; + + if (notificationMessage) // if there is a pending startup notification + [self notificationReceived]; // go ahead and process it } +/* - (void)isEnabled:(NSMutableArray *)arguments withDict:(NSMutableDictionary *)options { UIRemoteNotificationType type = [[UIApplication sharedApplication] enabledRemoteNotificationTypes]; NSString *jsStatement = [NSString stringWithFormat:@"navigator.PushPlugin.isEnabled = %d;", type != UIRemoteNotificationTypeNone]; NSLog(@"JSStatement %@",jsStatement); } +*/ - (void)didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken { @@ -104,40 +124,22 @@ - (void)didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken { // one is actually disabled. So we are literally checking to see if rnTypes matches what is turned on, instead of by number. The "tricky" part is that the // single notification types will only match if they are the ONLY one enabled. Likewise, when we are checking for a pair of notifications, it will only be // true if those two notifications are on. This is why the code is written this way - if(rntypes == UIRemoteNotificationTypeBadge){ - pushBadge = @"enabled"; - } - else if(rntypes == UIRemoteNotificationTypeAlert){ - pushAlert = @"enabled"; - } - else if(rntypes == UIRemoteNotificationTypeSound){ - pushSound = @"enabled"; - } - else if(rntypes == ( UIRemoteNotificationTypeBadge | UIRemoteNotificationTypeAlert)){ - pushBadge = @"enabled"; - pushAlert = @"enabled"; + if(rntypes & UIRemoteNotificationTypeBadge){ + pushBadge = @"enabled"; } - else if(rntypes == ( UIRemoteNotificationTypeBadge | UIRemoteNotificationTypeSound)){ - pushBadge = @"enabled"; - pushSound = @"enabled"; + if(rntypes & UIRemoteNotificationTypeAlert) { + pushAlert = @"enabled"; } - else if(rntypes == ( UIRemoteNotificationTypeAlert | UIRemoteNotificationTypeSound)){ - pushAlert = @"enabled"; - pushSound = @"enabled"; - } - else if(rntypes == ( UIRemoteNotificationTypeBadge | UIRemoteNotificationTypeAlert | UIRemoteNotificationTypeSound)){ - pushBadge = @"enabled"; - pushAlert = @"enabled"; - pushSound = @"enabled"; + if(rntypes & UIRemoteNotificationTypeSound) { + pushSound = @"enabled"; } [results setValue:pushBadge forKey:@"pushBadge"]; [results setValue:pushAlert forKey:@"pushAlert"]; [results setValue:pushSound forKey:@"pushSound"]; - // Get the users Device Model, Display Name, Unique ID, Token & Version Number + // Get the users Device Model, Display Name, Token & Version Number UIDevice *dev = [UIDevice currentDevice]; - [results setValue:dev.uniqueIdentifier forKey:@"deviceUuid"]; [results setValue:dev.name forKey:@"deviceName"]; [results setValue:dev.model forKey:@"deviceModel"]; [results setValue:dev.systemVersion forKey:@"deviceSystemVersion"]; @@ -153,21 +155,25 @@ - (void)didFailToRegisterForRemoteNotificationsWithError:(NSError *)error - (void)notificationReceived { NSLog(@"Notification received"); - NSLog(@"Msg: %@", [notificationMessage descriptionWithLocale:[NSLocale currentLocale] indent:4]); - if (notificationMessage) { + if (notificationMessage && self.callback) + { NSMutableString *jsonStr = [NSMutableString stringWithString:@"{"]; - if ([notificationMessage objectForKey:@"alert"]) - [jsonStr appendFormat:@"alert:'%@',", [[notificationMessage objectForKey:@"alert"] stringByReplacingOccurrencesOfString:@"'" withString:@"\\'"]]; - - if ([notificationMessage objectForKey:@"badge"]) - [jsonStr appendFormat:@"badge:%d,", [[notificationMessage objectForKey:@"badge"] intValue]]; - if ([notificationMessage objectForKey:@"sound"]) - [jsonStr appendFormat:@"sound:'%@',", [notificationMessage objectForKey:@"sound"]]; + [self parseDictionary:notificationMessage intoJSON:jsonStr]; + if (isInline) + { + [jsonStr appendFormat:@"foreground:\"%d\"", 1]; + isInline = NO; + } + else + [jsonStr appendFormat:@"foreground:\"%d\"", 0]; + [jsonStr appendString:@"}"]; + NSLog(@"Msg: %@", jsonStr); + NSString * jsCallBack = [NSString stringWithFormat:@"%@(%@);", self.callback, jsonStr]; [self.webView stringByEvaluatingJavaScriptFromString:jsCallBack]; @@ -175,22 +181,47 @@ - (void)notificationReceived { } } -- (void)setApplicationIconBadgeNumber:(NSMutableArray *)arguments withDict:(NSMutableDictionary *)options { - DLog(@"setApplicationIconBadgeNumber:%@\n withDict:%@", arguments, options); +// reentrant method to drill down and surface all sub-dictionaries' key/value pairs into the top level json +-(void)parseDictionary:(NSDictionary *)inDictionary intoJSON:(NSMutableString *)jsonString +{ + NSArray *keys = [inDictionary allKeys]; + NSString *key; - self.callbackId = [arguments pop]; + for (key in keys) + { + id thisObject = [inDictionary objectForKey:key]; + if ([thisObject isKindOfClass:[NSDictionary class]]) + [self parseDictionary:thisObject intoJSON:jsonString]; + else if ([thisObject isKindOfClass:[NSString class]]) + [jsonString appendFormat:@"\"%@\":\"%@\",", + key, + [[[[inDictionary objectForKey:key] + stringByReplacingOccurrencesOfString:@"\\" withString:@"\\\\"] + stringByReplacingOccurrencesOfString:@"\"" withString:@"\\\""] + stringByReplacingOccurrencesOfString:@"\n" withString:@"\\n"]]; + else { + [jsonString appendFormat:@"\"%@\":\"%@\",", key, [inDictionary objectForKey:key]]; + } + } +} + +- (void)setApplicationIconBadgeNumber:(CDVInvokedUrlCommand *)command { + + self.callbackId = command.callbackId; + + NSMutableDictionary* options = [command.arguments objectAtIndex:0]; int badge = [[options objectForKey:@"badge"] intValue] ?: 0; + [[UIApplication sharedApplication] setApplicationIconBadgeNumber:badge]; - + [self successWithMessage:[NSString stringWithFormat:@"app badge count set to %d", badge]]; } - -(void)successWithMessage:(NSString *)message { CDVPluginResult *commandResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsString:message]; - [self writeJavascript:[commandResult toSuccessCallbackString:self.callbackId]]; + [self.commandDelegate sendPluginResult:commandResult callbackId:self.callbackId]; } -(void)failWithMessage:(NSString *)message withError:(NSError *)error @@ -198,7 +229,7 @@ -(void)failWithMessage:(NSString *)message withError:(NSError *)error NSString *errorMessage = (error) ? [NSString stringWithFormat:@"%@ - %@", message, [error localizedDescription]] : message; CDVPluginResult *commandResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:errorMessage]; - [self writeJavascript:[commandResult toErrorCallbackString:self.callbackId]]; + [self.commandDelegate sendPluginResult:commandResult callbackId:self.callbackId]; } @end diff --git a/src/wp8/PushPlugin.cs b/src/wp8/PushPlugin.cs new file mode 100644 index 00000000..724f2bf9 --- /dev/null +++ b/src/wp8/PushPlugin.cs @@ -0,0 +1,169 @@ +using Microsoft.Phone.Controls; +using Microsoft.Phone.Notification; +using System; +using System.Diagnostics; +using System.Text; +using System.Threading; +using System.Runtime.Serialization; +using System.Windows; + +namespace WPCordovaClassLib.Cordova.Commands +{ + public class PushPlugin : BaseCommand + { + private HttpNotificationChannel pushChannel; + private string channelName; + private string toastCallback; + + public void register(string options) + { + Options pushOptions; + + try + { + string[] args = JSON.JsonHelper.Deserialize(options); + pushOptions = JSON.JsonHelper.Deserialize(args[0]); + this.channelName = pushOptions.ChannelName; + this.toastCallback = pushOptions.NotificationCallback; + } + catch (Exception) + { + DispatchCommandResult(new PluginResult(PluginResult.Status.JSON_EXCEPTION)); + return; + } + + pushChannel = HttpNotificationChannel.Find(channelName); + if (pushChannel == null) + { + pushChannel = new HttpNotificationChannel(channelName); + pushChannel.ChannelUriUpdated += new EventHandler(PushChannel_ChannelUriUpdated); + pushChannel.ErrorOccurred += new EventHandler(PushChannel_ErrorOccurred); + pushChannel.ShellToastNotificationReceived += new EventHandler(PushChannel_ShellToastNotificationReceived); + pushChannel.Open(); + pushChannel.BindToShellToast(); + } + else + { + pushChannel.ChannelUriUpdated += new EventHandler(PushChannel_ChannelUriUpdated); + pushChannel.ErrorOccurred += new EventHandler(PushChannel_ErrorOccurred); + pushChannel.ShellToastNotificationReceived += new EventHandler(PushChannel_ShellToastNotificationReceived); + + RegisterResult result = new RegisterResult(); + result.ChannelName = this.channelName; + result.Uri = pushChannel.ChannelUri.ToString(); + this.DispatchCommandResult(new PluginResult(PluginResult.Status.OK, result)); + } + } + + void PushChannel_ChannelUriUpdated(object sender, NotificationChannelUriEventArgs e) + { + // return uri to js + RegisterResult result = new RegisterResult(); + result.ChannelName = this.channelName; + result.Uri = pushChannel.ChannelUri.ToString(); + this.DispatchCommandResult(new PluginResult(PluginResult.Status.OK, result)); + } + + void PushChannel_ErrorOccurred(object sender, NotificationChannelErrorEventArgs e) + { + // call error handler and return uri + RegisterError err = new RegisterError(); + err.Code = e.ErrorCode.ToString(); + err.Message = e.Message; + this.DispatchCommandResult(new PluginResult(PluginResult.Status.ERROR, err)); + } + + void PushChannel_ShellToastNotificationReceived(object sender, NotificationEventArgs e) + { + StringBuilder message = new StringBuilder(); + string relativeUri = string.Empty; + + Toast toast = new Toast(); + if (e.Collection.ContainsKey("wp:Text1")) + { + toast.Title = e.Collection["wp:Text1"]; + } + if (e.Collection.ContainsKey("wp:Text2")) + { + toast.Subtitle = e.Collection["wp:Text2"]; + } + if (e.Collection.ContainsKey("wp:Param")) + { + toast.Param = e.Collection["wp:Param"]; + } + + PluginResult result = new PluginResult(PluginResult.Status.OK, toast); + + Deployment.Current.Dispatcher.BeginInvoke(() => + { + PhoneApplicationFrame frame = Application.Current.RootVisual as PhoneApplicationFrame; + if (frame != null) + { + PhoneApplicationPage page = frame.Content as PhoneApplicationPage; + if (page != null) + { + CordovaView cView = page.FindName("CordovaView") as CordovaView; // was: PGView + if (cView != null) + { + cView.Browser.Dispatcher.BeginInvoke((ThreadStart)delegate() + { + try + { + cView.Browser.InvokeScript("execScript", this.toastCallback + "(" + result.Message + ")"); + } + catch (Exception ex) + { + Debug.WriteLine("ERROR: Exception in InvokeScriptCallback :: " + ex.Message); + } + + }); + } + } + } + }); + } + + [DataContract] + public class Toast + { + [DataMember(Name = "text1", IsRequired = false)] + public string Title { get; set; } + + [DataMember(Name = "text2", IsRequired = false)] + public string Subtitle { get; set; } + + [DataMember(Name = "param", IsRequired = false)] + public string Param { get; set; } + } + + [DataContract] + public class Options + { + [DataMember(Name = "channelName", IsRequired = true)] + public string ChannelName { get; set; } + + [DataMember(Name = "ecb", IsRequired = false)] + public string NotificationCallback { get; set; } + } + + [DataContract] + public class RegisterResult + { + [DataMember(Name = "uri", IsRequired = true)] + public string Uri { get; set; } + + [DataMember(Name = "channel", IsRequired = true)] + public string ChannelName { get; set; } + } + + [DataContract] + public class RegisterError + { + [DataMember(Name = "code", IsRequired = true)] + public string Code { get; set; } + + [DataMember(Name = "message", IsRequired = true)] + public string Message { get; set; } + } + } +} \ No newline at end of file diff --git a/www/PushNotification.js b/www/PushNotification.js index 77121cdc..f4d800f4 100644 --- a/www/PushNotification.js +++ b/www/PushNotification.js @@ -1,28 +1,68 @@ -(function(cordova) { - var cordovaRef = window.PhoneGap || window.Cordova || window.cordova; +var PushNotification = function() { +}; - function PushNotification() {} - // Call this to register for push notifications. Content of [options] depends on whether we are working with APNS (iOS) or GCM (Android) - PushNotification.prototype.register = function(successCallback, errorCallback, options) { - cordovaRef.exec(successCallback, errorCallback, "PushPlugin", "register", [options]); - }; +// Call this to register for push notifications. Content of [options] depends on whether we are working with APNS (iOS) or GCM (Android) +PushNotification.prototype.register = function(successCallback, errorCallback, options) { + if (errorCallback == null) { errorCallback = function() {}} - // Call this to unregister for push notifications - PushNotification.prototype.unregister = function(successCallback, errorCallback) { - cordovaRef.exec(successCallback, errorCallback, "PushPlugin", "unregister", []); - }; + if (typeof errorCallback != "function") { + console.log("PushNotification.register failure: failure parameter not a function"); + return + } + + if (typeof successCallback != "function") { + console.log("PushNotification.register failure: success callback parameter must be a function"); + return + } + + cordova.exec(successCallback, errorCallback, "PushPlugin", "register", [options]); +}; + +// Call this to unregister for push notifications +PushNotification.prototype.unregister = function(successCallback, errorCallback) { + if (errorCallback == null) { errorCallback = function() {}} + + if (typeof errorCallback != "function") { + console.log("PushNotification.unregister failure: failure parameter not a function"); + return + } + + if (typeof successCallback != "function") { + console.log("PushNotification.unregister failure: success callback parameter must be a function"); + return + } + + cordova.exec(successCallback, errorCallback, "PushPlugin", "unregister", []); +}; - // Call this to set the application icon badge - PushNotification.prototype.setApplicationIconBadgeNumber = function(successCallback, badge) { - cordovaRef.exec(successCallback, successCallback, "PushPlugin", "setApplicationIconBadgeNumber", [{badge: badge}]); - }; - - cordova.addConstructor(function() { - if(!window.plugins) - window.plugins = {}; - window.plugins.pushNotification = new PushNotification(); - }); - - })(window.cordova || window.Cordova || window.PhoneGap); +// Call this to set the application icon badge +PushNotification.prototype.setApplicationIconBadgeNumber = function(successCallback, errorCallback, badge) { + if (errorCallback == null) { errorCallback = function() {}} + + if (typeof errorCallback != "function") { + console.log("PushNotification.setApplicationIconBadgeNumber failure: failure parameter not a function"); + return + } + + if (typeof successCallback != "function") { + console.log("PushNotification.setApplicationIconBadgeNumber failure: success callback parameter must be a function"); + return + } + + cordova.exec(successCallback, errorCallback, "PushPlugin", "setApplicationIconBadgeNumber", [{badge: badge}]); +}; + +//------------------------------------------------------------------- + +if(!window.plugins) { + window.plugins = {}; +} +if (!window.plugins.pushNotification) { + window.plugins.pushNotification = new PushNotification(); +} + +if (module.exports) { + module.exports = PushNotification; +} \ No newline at end of file