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.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/amazon/ADMHandlerActivity.java b/src/amazon/ADMHandlerActivity.java
new file mode 100644
index 00000000..6d7e3dd3
--- /dev/null
+++ b/src/amazon/ADMHandlerActivity.java
@@ -0,0 +1,70 @@
+/*
+ * Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * 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.amazon.cordova.plugin;
+
+import android.app.Activity;
+import android.content.Intent;
+import android.content.pm.PackageManager;
+import android.os.Bundle;
+
+public class ADMHandlerActivity extends Activity {
+
+ /*
+ * 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);
+ 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 isCordovaActive) {
+ Bundle extras = getIntent().getExtras();
+
+ if (extras != null) {
+ Bundle originalExtras = extras
+ .getBundle(ADMMessageHandler.PUSH_BUNDLE);
+ originalExtras.putBoolean(PushPlugin.COLDSTART, !isCordovaActive);
+ ADMMessageHandler.cancelNotification(this);
+ PushPlugin.sendExtras(originalExtras);
+ // clean up the noticiationIntent extra
+ ADMMessageHandler.cleanupNotificationIntent();
+ }
+ }
+
+ /**
+ * Forces the main activity to re-launch if it's unloaded.
+ */
+ private void forceMainActivityReload(/* Bundle extras */) {
+ PackageManager pm = getPackageManager();
+ Intent launchIntent = pm
+ .getLaunchIntentForPackage(getApplicationContext()
+ .getPackageName());
+ startActivity(launchIntent);
+ }
+
+}
diff --git a/src/amazon/ADMMessageHandler.java b/src/amazon/ADMMessageHandler.java
new file mode 100644
index 00000000..7fe79df5
--- /dev/null
+++ b/src/amazon/ADMMessageHandler.java
@@ -0,0 +1,284 @@
+/*
+ * Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * 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.amazon.cordova.plugin;
+
+import org.apache.cordova.CordovaActivity;
+import org.json.JSONObject;
+import android.app.Notification;
+import android.app.NotificationManager;
+import android.app.PendingIntent;
+import android.content.Context;
+import android.content.Intent;
+import android.content.SharedPreferences;
+import android.os.Bundle;
+import android.text.Html;
+import android.text.TextUtils;
+import android.util.Log;
+import android.app.Notification.Builder;
+
+import com.amazon.device.messaging.ADMMessageHandlerBase;
+import com.amazon.device.messaging.ADMMessageReceiver;
+
+/**
+ * The ADMMessageHandler class receives messages sent by ADM via the receiver.
+ */
+
+public class ADMMessageHandler extends ADMMessageHandlerBase {
+
+ private static final String ERROR_EVENT = "error";
+ public static final String PUSH_BUNDLE = "pushBundle";
+ public static final String ERROR_MSG = "msg";
+ private static final String SHOW_MESSAGE_PREF = "showmessageinnotification";
+ private static final String DEFAULT_MESSAGE_PREF = "defaultnotificationmessage";
+ private static boolean shouldShowOfflineMessage = false;
+ private static String defaultOfflineMessage = null;
+ private static final String PREFS_NAME = "PushPluginPrefs";
+ private static final String DEFAULT_MESSAGE_TEXT = "You have a new message.";
+
+ // An identifier for ADM notification unique within your application
+ // It allows you to update the same notification later on
+ public static final int NOTIFICATION_ID = 519;
+ static Intent notificationIntent = null;
+
+ /**
+ * Class constructor.
+ */
+ public ADMMessageHandler() {
+ super(ADMMessageHandler.class.getName());
+ }
+
+ /**
+ * Class constructor, including the className argument.
+ *
+ * @param className
+ * The name of the class.
+ */
+ public ADMMessageHandler(final String className) {
+ super(className);
+ }
+
+ /**
+ * The Receiver class listens for messages from ADM and forwards them to the ADMMessageHandler class.
+ */
+ public static class Receiver extends ADMMessageReceiver {
+ public Receiver() {
+ super(ADMMessageHandler.class);
+
+ }
+
+ // Nothing else is required here; your broadcast receiver automatically
+ // forwards intents to your service for processing.
+ }
+
+ /** {@inheritDoc} */
+ @Override
+ protected void onRegistered(final String newRegistrationId) {
+ // You start the registration process by calling startRegister() in your Main Activity.
+ // When the registration ID is ready, ADM calls onRegistered()
+ // on your app. Transmit the passed-in registration ID to your server, so
+ // your server can send messages to this app instance. onRegistered() is also
+ // called if your registration ID is rotated or changed for any reason;
+ // your app should pass the new registration ID to your server if this occurs.
+
+ // we fire the register event in the web app, register handler should
+ // fire to send the registration ID to your server via a header key/value pair over HTTP.(AJAX)
+ PushPlugin.sendRegistrationIdWithEvent(PushPlugin.REGISTER_EVENT,
+ newRegistrationId);
+ }
+
+ /** {@inheritDoc} */
+ @Override
+ protected void onUnregistered(final String registrationId) {
+ // If your app is unregistered on this device, inform your server that
+ // this app instance is no longer a valid target for messages.
+ PushPlugin.sendRegistrationIdWithEvent(PushPlugin.UNREGISTER_EVENT,
+ registrationId);
+ }
+
+ /** {@inheritDoc} */
+ @Override
+ protected void onRegistrationError(final String errorId) {
+ // You should consider a registration error fatal. In response, your app
+ // may degrade gracefully, or you may wish to notify the user that this part
+ // of your app's functionality is not available.
+ try {
+ JSONObject json;
+ json = new JSONObject().put(PushPlugin.EVENT, ERROR_EVENT);
+ json.put(ADMMessageHandler.ERROR_MSG, errorId);
+
+ PushPlugin.sendJavascript(json);
+ } catch (Exception e) {
+ Log.getStackTraceString(e);
+ }
+ }
+
+ /** {@inheritDoc} */
+ @Override
+ protected void onMessage(final Intent intent) {
+ // Extract the message content from the set of extras attached to
+ // the com.amazon.device.messaging.intent.RECEIVE intent.
+
+ // Extract the payload from the message
+ Bundle extras = intent.getExtras();
+ if (extras != null && (extras.getString(PushPlugin.MESSAGE) != null)) {
+ // if we are in the foreground, just surface the payload, else post
+ // it to the statusbar
+ if (PushPlugin.isInForeground()) {
+ extras.putBoolean(PushPlugin.FOREGROUND, true);
+ PushPlugin.sendExtras(extras);
+ } else {
+ extras.putBoolean(PushPlugin.FOREGROUND, false);
+ createNotification(this, extras);
+ }
+ }
+ }
+
+ /**
+ * Creates a notification when app is not running or is not in foreground. It puts the message info into the Intent
+ * extra
+ *
+ * @param context
+ * @param extras
+ */
+ public void createNotification(Context context, Bundle extras) {
+ NotificationManager notificationManager = (NotificationManager) getSystemService(Context.NOTIFICATION_SERVICE);
+ String appName = getAppName(this);
+
+ // reuse the intent so that we can combine multiple messages into extra
+ if (notificationIntent == null) {
+ notificationIntent = new Intent(this, ADMHandlerActivity.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);
+
+ final Builder notificationBuilder = new Notification.Builder(context);
+ notificationBuilder.setSmallIcon(context.getApplicationInfo().icon)
+ .setWhen(System.currentTimeMillis())
+ .setContentIntent(contentIntent);
+
+ if (this.shouldShowMessageInNotification()) {
+ String message = extras.getString(PushPlugin.MESSAGE);
+ notificationBuilder.setContentText(Html.fromHtml(message).toString());
+ } else {
+ notificationBuilder.setContentText(this.defaultMessageTextInNotification());
+ }
+
+ String title = appName;
+ notificationBuilder.setContentTitle(title).setTicker(title);
+ notificationBuilder.setAutoCancel(true);
+ // Because the ID remains unchanged, the existing notification is updated.
+ notificationManager.notify((String) appName, NOTIFICATION_ID,
+ notificationBuilder.getNotification());
+ }
+
+ public static void cancelNotification(Context context) {
+ NotificationManager mNotificationManager = (NotificationManager) context
+ .getSystemService(Context.NOTIFICATION_SERVICE);
+ mNotificationManager.cancel((String) getAppName(context),
+ NOTIFICATION_ID);
+ }
+
+ private static String getAppName(Context context) {
+ CharSequence appName = context.getPackageManager().getApplicationLabel(
+ context.getApplicationInfo());
+ return (String) appName;
+ }
+
+ // clean up the message in the intent
+ static void cleanupNotificationIntent() {
+ if (notificationIntent != null) {
+ Bundle pushBundle = notificationIntent.getExtras().getBundle(
+ PUSH_BUNDLE);
+ if (pushBundle != null) {
+ pushBundle.clear();
+ }
+
+ }
+ }
+
+ public static Bundle getOfflineMessage() {
+ Bundle pushBundle = null;
+ if (notificationIntent != null) {
+ pushBundle = notificationIntent.getExtras().getBundle(PUSH_BUNDLE);
+ if (pushBundle.isEmpty()) {
+ pushBundle = null;
+ }
+ }
+ return pushBundle;
+ }
+
+ /**
+ * Reads "shownotificationmessage" & "defaultnotificationmessage" config options
+ * If this is first-time it saves them to sharedPreferences so they can be read
+ * when app is forced-stop or killed
+ */
+ public static void saveConfigOptions(Context context) {
+ if (context != null && TextUtils.isEmpty(defaultOfflineMessage)) {
+ // read config options from config.xml
+ shouldShowOfflineMessage = ((CordovaActivity) context)
+ .getBooleanProperty(SHOW_MESSAGE_PREF, false);
+ defaultOfflineMessage = ((CordovaActivity) context)
+ .getStringProperty(DEFAULT_MESSAGE_PREF, null);
+
+ // save them to sharedPreferences if necessary
+ SharedPreferences config = context.getApplicationContext().getSharedPreferences(PREFS_NAME, 0);
+ SharedPreferences.Editor editor = config.edit();
+ editor.putBoolean(SHOW_MESSAGE_PREF, shouldShowOfflineMessage);
+ editor.putString(DEFAULT_MESSAGE_PREF, defaultOfflineMessage);
+ // save prefs to disk
+ editor.commit();
+ }
+
+ }
+
+ /**
+ * Gets "shownotificationmessage" config option
+ *
+ * @return returns boolean- true is shownotificationmessage is set to true in config.xml/sharedPreferences otherwise false
+ */
+ private boolean shouldShowMessageInNotification() {
+ //check if have cached copy of this option
+ if (TextUtils.isEmpty(defaultOfflineMessage)) {
+ //need to read it from sharedPreferences
+ SharedPreferences config = this.getApplicationContext().getSharedPreferences(PREFS_NAME,0);
+ if (config != null) {
+ shouldShowOfflineMessage = config.getBoolean(SHOW_MESSAGE_PREF, true);
+ }
+ }
+ return shouldShowOfflineMessage;
+ }
+
+ /**
+ * Gets "defaultnotificationmessage" config option
+ *
+ * @return returns default message provided by user in cofing.xml/sharedPreferences
+ */
+ private String defaultMessageTextInNotification() {
+ //check if have cached copy of this option
+ if (TextUtils.isEmpty(defaultOfflineMessage)) {
+ SharedPreferences config = this.getApplicationContext().getSharedPreferences(PREFS_NAME,0);
+ if (config != null) {
+ defaultOfflineMessage = config.getString(DEFAULT_MESSAGE_PREF, DEFAULT_MESSAGE_TEXT);
+ }
+ }
+ return defaultOfflineMessage;
+ }
+}
diff --git a/src/amazon/PushPlugin.java b/src/amazon/PushPlugin.java
new file mode 100644
index 00000000..1d610cde
--- /dev/null
+++ b/src/amazon/PushPlugin.java
@@ -0,0 +1,429 @@
+/*
+ * Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * 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.amazon.cordova.plugin;
+
+import org.apache.cordova.CallbackContext;
+import org.apache.cordova.CordovaInterface;
+import org.apache.cordova.CordovaPlugin;
+import org.apache.cordova.CordovaWebView;
+import org.apache.cordova.CordovaActivity;
+import org.apache.cordova.LOG;
+import org.json.JSONArray;
+import org.json.JSONException;
+import com.amazon.device.messaging.ADM;
+import android.app.Activity;
+import android.os.Bundle;
+import android.text.TextUtils;
+import android.util.Log;
+
+import java.util.Iterator;
+
+import org.json.JSONObject;
+
+public class PushPlugin extends CordovaPlugin {
+
+ private static String TAG = "PushPlugin";
+ /**
+ * @uml.property name="adm"
+ * @uml.associationEnd
+ */
+ private ADM adm = null;
+ /**
+ * @uml.property name="activity"
+ * @uml.associationEnd
+ */
+ private Activity activity = null;
+ private static CordovaWebView webview = null;
+ private static String notificationHandlerCallBack;
+ private static boolean isForeground = false;
+ private static Bundle gCachedExtras = null;
+
+
+ public static final String REGISTER = "register";
+ public static final String UNREGISTER = "unregister";
+ public static final String REGISTER_EVENT = "registered";
+ public static final String UNREGISTER_EVENT = "unregistered";
+ public static final String MESSAGE = "message";
+ public static final String ECB = "ecb";
+ public static final String EVENT = "event";
+ public static final String PAYLOAD = "payload";
+ public static final String FOREGROUND = "foreground";
+ public static final String REG_ID = "regid";
+ public static final String COLDSTART = "coldstart";
+
+ private static final String NON_AMAZON_DEVICE_ERROR = "PushNotifications using Amazon Device Messaging is only supported on Kindle Fire devices (2nd Generation and Later only).";
+ private static final String ADM_NOT_SUPPORTED_ERROR = "Amazon Device Messaging is not supported on this device.";
+ private static final String REGISTER_OPTIONS_NULL = "Register options are not specified.";
+ private static final String ECB_NOT_SPECIFIED = "ecb(eventcallback) option is not specified in register().";
+ private static final String ECB_NAME_NOT_SPECIFIED = "ecb(eventcallback) value is missing in options for register().";
+ private static final String REGISTRATION_SUCCESS_RESPONSE = "Registration started...";
+ private static final String UNREGISTRATION_SUCCESS_RESPONSE = "Unregistration started...";
+
+ private static final String MODEL_FIRST_GEN = "Kindle Fire";
+
+ public enum ADMReadiness {
+ INITIALIZED, NON_AMAZON_DEVICE, ADM_NOT_SUPPORTED
+ }
+
+ /**
+ * Sets the context of the Command. This can then be used to do things like get file paths associated with the
+ * Activity.
+ *
+ * @param cordova
+ * The context of the main Activity.
+ * @param webView
+ * The associated CordovaWebView.
+ */
+ @Override
+ public void initialize(CordovaInterface cordova, CordovaWebView webView) {
+ super.initialize(cordova, webView);
+ // Initialize only for Amazon devices 2nd Generation and later
+ if (this.isAmazonDevice() && !isFirstGenKindleFireDevice()) {
+ adm = new ADM(cordova.getActivity());
+ activity = (CordovaActivity) cordova.getActivity();
+ webview = this.webView;
+ isForeground = true;
+ ADMMessageHandler.saveConfigOptions(activity);
+ } else {
+ LOG.e(TAG, NON_AMAZON_DEVICE_ERROR);
+ }
+ }
+
+ /**
+ * Checks if current device manufacturer is Amazon by using android.os.Build.MANUFACTURER property
+ *
+ * @return returns true for all Kindle Fire OS devices.
+ */
+ private boolean isAmazonDevice() {
+ String deviceMaker = android.os.Build.MANUFACTURER;
+ return deviceMaker.equalsIgnoreCase("Amazon");
+ }
+
+ /**
+ * Check if device is First generation Kindle
+ *
+ * @return if device is First generation Kindle
+ */
+ private static boolean isFirstGenKindleFireDevice() {
+ return android.os.Build.MODEL.equals(MODEL_FIRST_GEN);
+ }
+ /**
+ * Checks if ADM is available and supported - could be one of three 1. Non Amazon device, hence no ADM support 2.
+ * ADM is not supported on this Kindle device (1st generation) 3. ADM is successfully initialized and ready to be
+ * used
+ *
+ * @return returns true for all Kindle Fire OS devices.
+ */
+ public ADMReadiness isPushPluginReady() {
+ if (adm == null) {
+ return ADMReadiness.NON_AMAZON_DEVICE;
+ } else if (!adm.isSupported()) {
+ return ADMReadiness.ADM_NOT_SUPPORTED;
+ }
+ return ADMReadiness.INITIALIZED;
+ }
+
+ /**
+ * @see Plugin#execute(String, JSONArray, String)
+ */
+ @Override
+ public boolean execute(final String request, final JSONArray args,
+ CallbackContext callbackContext) throws JSONException {
+ try {
+ // check ADM readiness
+ ADMReadiness ready = isPushPluginReady();
+ if (ready == ADMReadiness.NON_AMAZON_DEVICE) {
+ callbackContext.error(NON_AMAZON_DEVICE_ERROR);
+ return false;
+ } else if (ready == ADMReadiness.ADM_NOT_SUPPORTED) {
+ callbackContext.error(ADM_NOT_SUPPORTED_ERROR);
+ return false;
+ } else if (callbackContext == null) {
+ LOG.e(TAG,
+ "CallbackConext is null. Notification to WebView is not possible. Can not proceed.");
+ return false;
+ }
+
+ // Process the request here
+ if (REGISTER.equals(request)) {
+
+ if (args == null) {
+ LOG.e(TAG, REGISTER_OPTIONS_NULL);
+ callbackContext.error(REGISTER_OPTIONS_NULL);
+ return false;
+ }
+
+ // parse args to get eventcallback name
+ if (args.isNull(0)) {
+ LOG.e(TAG, ECB_NOT_SPECIFIED);
+ callbackContext.error(ECB_NOT_SPECIFIED);
+ return false;
+ }
+
+ JSONObject jo = args.getJSONObject(0);
+ if (jo.getString("ecb").isEmpty()) {
+ LOG.e(TAG, ECB_NAME_NOT_SPECIFIED);
+ callbackContext.error(ECB_NAME_NOT_SPECIFIED);
+ return false;
+ }
+ callbackContext.success(REGISTRATION_SUCCESS_RESPONSE);
+ notificationHandlerCallBack = jo.getString(ECB);
+ String regId = adm.getRegistrationId();
+ LOG.d(TAG, "regId = " + regId);
+ if (regId == null) {
+ adm.startRegister();
+ } else {
+ sendRegistrationIdWithEvent(REGISTER_EVENT, regId);
+ }
+
+ // see if there are any messages while app was in background and
+ // launched via app icon
+ LOG.d(TAG,"checking for offline message..");
+ deliverPendingMessageAndCancelNotifiation();
+ return true;
+
+ } else if (UNREGISTER.equals(request)) {
+ adm.startUnregister();
+ callbackContext.success(UNREGISTRATION_SUCCESS_RESPONSE);
+ return true;
+ } else {
+ LOG.e(TAG, "Invalid action : " + request);
+ callbackContext.error("Invalid action : " + request);
+ return false;
+ }
+ } catch (final Exception e) {
+ callbackContext.error(e.getMessage());
+ }
+
+ return false;
+ }
+
+ /**
+ * Checks if any bundle extras were cached while app was not running
+ *
+ * @return returns tru if cached Bundle is not null otherwise true.
+ */
+ public boolean cachedExtrasAvailable() {
+ return (gCachedExtras != null);
+ }
+
+ /**
+ * Checks if offline message was pending to be delivered from notificationIntent. Sends it to webView(JS) if it is
+ * and also clears notification from the NotificaitonCenter.
+ */
+ private boolean deliverOfflineMessages() {
+ LOG.d(TAG,"deliverOfflineMessages()");
+ Bundle pushBundle = ADMMessageHandler.getOfflineMessage();
+ if (pushBundle != null) {
+ LOG.d(TAG,"Sending offline message...");
+ sendExtras(pushBundle);
+ ADMMessageHandler.cleanupNotificationIntent();
+ return true;
+ }
+ return false;
+ }
+
+ // lifecyle callback to set the isForeground
+ @Override
+ public void onPause(boolean multitasking) {
+ LOG.d(TAG, "onPause");
+ super.onPause(multitasking);
+ isForeground = false;
+ }
+
+ @Override
+ public void onResume(boolean multitasking) {
+ LOG.d(TAG, "onResume");
+ super.onResume(multitasking);
+ isForeground = true;
+ //Check if there are any offline messages?
+ deliverPendingMessageAndCancelNotifiation();
+ }
+
+ @Override
+ public void onDestroy() {
+ LOG.d(TAG, "onDestroy");
+ super.onDestroy();
+ isForeground = false;
+ webview = null;
+ notificationHandlerCallBack = null;
+ }
+
+ /**
+ * Indicates if app is in foreground or not.
+ *
+ * @return returns true if app is running otherwise false.
+ */
+ public static boolean isInForeground() {
+ return isForeground;
+ }
+
+ /**
+ * Indicates if app is killed or not
+ *
+ * @return returns true if app is killed otherwise false.
+ */
+ public static boolean isActive() {
+ return webview != null;
+ }
+
+ /**
+ * Delivers pending/offline messages if any
+ *
+ * @return returns true if there were any pending messages otherwise false.
+ */
+ public boolean deliverPendingMessageAndCancelNotifiation() {
+ boolean delivered = false;
+ LOG.d(TAG,"deliverPendingMessages()");
+ if (cachedExtrasAvailable()) {
+ LOG.v(TAG, "sending cached extras");
+ sendExtras(gCachedExtras);
+ gCachedExtras = null;
+ delivered = true;
+ } else {
+ delivered = deliverOfflineMessages();
+ }
+ // Clear the notification if any exists
+ ADMMessageHandler.cancelNotification(activity);
+
+ return delivered;
+ }
+ /**
+ * Sends register/unregiste events to JS
+ *
+ * @param String
+ * - eventName - "register", "unregister"
+ * @param String
+ * - valid registrationId
+ */
+ public static void sendRegistrationIdWithEvent(String event,
+ String registrationId) {
+ if (TextUtils.isEmpty(event) || TextUtils.isEmpty(registrationId)) {
+ return;
+ }
+ try {
+ JSONObject json;
+ json = new JSONObject().put(EVENT, event);
+ json.put(REG_ID, registrationId);
+
+ sendJavascript(json);
+ } catch (Exception e) {
+ Log.getStackTraceString(e);
+ }
+ }
+
+ /**
+ * Sends events to JS using cordova nativeToJS bridge.
+ *
+ * @param JSONObject
+ */
+ public static boolean sendJavascript(JSONObject json) {
+ if (json == null) {
+ LOG.i(TAG, "JSON object is empty. Nothing to send to JS.");
+ return true;
+ }
+
+ if (notificationHandlerCallBack != null && webview != null) {
+ String jsToSend = "javascript:" + notificationHandlerCallBack + "("
+ + json.toString() + ")";
+ LOG.v(TAG, "sendJavascript: " + jsToSend);
+ webview.sendJavascript(jsToSend);
+ return true;
+ }
+ return false;
+ }
+
+ /*
+ * 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 (!sendJavascript(convertBundleToJson(extras))) {
+ LOG.v(TAG,
+ "sendExtras: could not send to JS. Caching extras to send at a later time.");
+ gCachedExtras = extras;
+ }
+ }
+ }
+
+ // serializes a bundle to JSON.
+ private static JSONObject convertBundleToJson(Bundle extras) {
+ if (extras == null) {
+ return null;
+ }
+
+ try {
+ JSONObject json;
+ json = new JSONObject().put(EVENT, MESSAGE);
+
+ JSONObject jsondata = new JSONObject();
+ Iterator- * 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: - *
- * 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
- * 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..aa563a34 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
@@ -55,12 +89,11 @@ - (void)applicationDidBecomeActive:(UIApplication *)application {
//zero badge
application.applicationIconBadgeNumber = 0;
- if (![self.viewController.webView isLoading] && self.launchNotification) {
+ if (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