Updated install script to request url scheme and minor fixes

Author: timflapper

Makefile

@@ -1,11 +1,11 @@
 test:
-	@bin/test-all
+	@export PLUGIN_ENV='test'; bin/test-all
 
 test-ios:
 	@bin/test-ios
 
 test-js:
-	@bin/test-js
+	@export PLUGIN_ENV='test'; bin/test-js
 
 test-appium:
 	@bin/test-appium

README.md

@@ -2,32 +2,25 @@
 
 [![Build Status](https://travis-ci.org/timflapper/cordova-spotify-plugin.svg?branch=master)](https://travis-ci.org/timflapper/cordova-spotify-plugin)
 
-This plugin provides a javascript API to Spotify's iOS SDK.
+This plugin provides a javascript API to Spotify's iOS SDK for Cordova applications.
 
-**Beware! this plugin is in a very early (alpha) stage. Please try it out but do not use for production.**
-
-## Do not use this plugin in a production environment!
-Currently the Spotify iOS SDK is in beta and breaking changes can occur without prior notice.
+_Android integration is planned for a future release_
 
 ## Installation
 
 1. Install the plugin:
 
 		`cordova plugin add https://github.com/timflapper/cordova-spotify-plugin`
 
-2. Run the install script to download the `Spotify.framework`
-        
-        `./plugins/com.timflapper.spotify/install.sh`
-
-3. Add the iOS playform to your project.
+2. Add the iOS platform to your project (if needed):
 
         `cordova platform add ios`
 
-    Or, if you already have ios as a platform please run:
-
-        `cordova prepare`
+3. The install script will start automatically. It will do two things:
+ - Ask you for a [custom URL scheme](http://bit.ly/1u11ZUz).
+ - Download and extract the Spotify iOS SDK.
 
-4. Try it out!
+That's it!
 
 ## API
 
@@ -39,3 +32,7 @@ You can use the Ruby script that is included in the Spotify iOS SDK Demo Project
 
 - [Download the Spotify iOS SDK](https://github.com/spotify/ios-sdk/releases)
 - Follow the instructions from the [Spotify iOS SDK beginner's tutorial](https://developer.spotify.com/technologies/spotify-ios-sdk/tutorial/).	
+
+## License
+
+[MIT](LICENSE)

install.sh

@@ -1,5 +1,27 @@
 #!/bin/sh
 
+if [ "$PLUGIN_ENV" == "test" ]; then
+  exit
+fi
+
+DEFAULT_SCHEME="spotify-cordova"
+
+echo "The Spotify SDK Plugin needs a URL scheme for authentication."
+echo "See http://bit.ly/1u11ZUz for more information"
+printf "Specify your URL scheme [$DEFAULT_SCHEME]: "
+
+read urlscheme
+
+if [ "$urlscheme" == "" ]; then
+  urlscheme="$DEFAULT_SCHEME"
+fi
+
+echo "Writing URL scheme to plugin.xml"
+
+mv plugins/com.timflapper.spotify/plugin.xml plugins/com.timflapper.spotify/plugin.bak.xml
+sed "s/{{URL_SCHEME}}/$urlscheme/g" plugins/com.timflapper.spotify/plugin.bak.xml > plugins/com.timflapper.spotify/plugin.xml
+rm plugins/com.timflapper.spotify/plugin.bak.xml
+
 echo "Removing placeholder"
 rm -rf plugins/com.timflapper.spotify/src/ios/Spotify.framework
 
@@ -9,9 +31,9 @@ cd plugins/com.timflapper.spotify/src/ios/tmp
 curl -OL "https://github.com/spotify/ios-sdk/archive/beta-6.tar.gz"
 
 echo "Extracting"
-tar xzvf beta-5.tar.gz
+tar xzvf beta-6.tar.gz
 cd ..
-mv tmp/ios-sdk-beta-5/Spotify.framework .
+mv tmp/ios-sdk-beta-6/Spotify.framework .
 rm -rf tmp
 
 echo "Finished!"

plugin.xml

@@ -33,7 +33,9 @@
   </js-module>
 
   <platform name="ios">
-    <config-file parent="/*" target="config.xml">
+    <hook type="before_plugin_install" src="install.sh" />
+
+    <config-file target="config.xml" parent="/*">
       <feature name="SpotifyPlugin">
         <param name="ios-package" value="SpotifyPlugin"/>
       </feature>
@@ -48,7 +50,7 @@
           <string>Spotify Auth</string>
           <key>CFBundleURLSchemes</key>
           <array>
-            <string>spotify-ios-sdk-beta</string>
+            <string>{{URL_SCHEME}}</string>
           </array>
         </dict>
       </array>

src/ios/SpotifyPlugin.h

@@ -11,8 +11,6 @@ NSDate *stringToDate(NSString *dateString);
 
 @interface SpotifyPlugin : CDVPlugin
 
-@property NSURL *callbackUrl;
-
 /* Linked to SPTAuth */
 - (void)authenticate:(CDVInvokedUrlCommand*)command;
 - (void)isSessionValid:(CDVInvokedUrlCommand*)command;

src/ios/SpotifyPlugin.m

@@ -29,28 +29,23 @@
     return [getDateFormatter() dateFromString:dateString];
 }
 
-@interface SpotifyPlugin()
-@end
-
 @implementation SpotifyPlugin
-@synthesize callbackUrl;
-- (void)pluginInitialize
-{
-    callbackUrl = [NSURL URLWithString:@"spotify-ios-sdk-beta://callback"];
-}
-
 - (void)authenticate:(CDVInvokedUrlCommand*)command
 {
     __weak SpotifyPlugin* weakSelf = self;
 
     NSArray *validResponseTypes = @[@"code", @"token"];
 
-    NSString *clientId = [command.arguments objectAtIndex:0];
-    NSString *responseType = [command.arguments objectAtIndex:1];
+    NSString *urlScheme = [command.arguments objectAtIndex:0];
+    NSString *clientId = [command.arguments objectAtIndex:1];
+    NSString *responseType = [command.arguments objectAtIndex:2];
+
+    NSURL *callbackUrl = [NSURL URLWithString: [NSString stringWithFormat:@"%@://callback", urlScheme]];
+
     NSURL *tokenSwapUrl;
     NSArray *scopes;
 
-    int argumentIndex = 2;
+    int argumentIndex = 3;
 
     if ([validResponseTypes indexOfObject:responseType] == NSNotFound) {
         CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsString:@"Invalid responseType"];

test/ios/SpotifyPluginTests.m

@@ -75,7 +75,7 @@ - (void)tearDown
 
 - (void)testAuthenticateSuccessWithCode
 {
-    NSArray *args = @[@"someRandomClientId", @"code", @"http://foo.bar:1234/swap", @[@"streaming"]];
+    NSArray *args = @[@"test-url-scheme", @"someRandomClientId", @"code", @"http://foo.bar:1234/swap", @[@"streaming"]];
 
     __block BOOL responseArrived = NO;
 
@@ -105,7 +105,7 @@ - (void)testAuthenticateSuccessWithCode
     double delayInSeconds = 0.005;
     dispatch_time_t popTime = dispatch_time(DISPATCH_TIME_NOW, delayInSeconds * NSEC_PER_SEC);
     dispatch_after(popTime, dispatch_get_main_queue(), ^(void){
-        NSURL *callbackURL = [NSURL URLWithString:@"spotify-ios-sdk-beta://callback?code=NQpvC5h6MnausBFRG2hJjXifw2CZrXzQIh4S_SgBfpcVi6svpZKXpwYyoLRYhWN8g4L-zoZqYK0hfFNFgMqTpESGvodAuXGngZFiKc16y7oeMRJTZaY3-_1BgnSO9cLwzgMOztqUCRJV23LjtmEurM9_BEhSm-smLgqQHUrLtXldCz-JpDOkckA"];
+        NSURL *callbackURL = [NSURL URLWithString:@"test-url-scheme://callback?code=NQpvC5h6MnausBFRG2hJjXifw2CZrXzQIh4S_SgBfpcVi6svpZKXpwYyoLRYhWN8g4L-zoZqYK0hfFNFgMqTpESGvodAuXGngZFiKc16y7oeMRJTZaY3-_1BgnSO9cLwzgMOztqUCRJV23LjtmEurM9_BEhSm-smLgqQHUrLtXldCz-JpDOkckA"];
 
         [[NSNotificationCenter defaultCenter]
          postNotification:[NSNotification notificationWithName:CDVPluginHandleOpenURLNotification
@@ -120,7 +120,7 @@ - (void)testAuthenticateSuccessWithCode
 
 - (void)testAuthenticateSuccessWithToken
 {
-    NSArray *args = @[@"someRandomClientId", @"token", @[@"streaming"]];
+    NSArray *args = @[@"test-url-scheme", @"someRandomClientId", @"token", @[@"streaming"]];
 
     __block BOOL responseArrived = NO;
 
@@ -142,7 +142,7 @@ - (void)testAuthenticateSuccessWithToken
     double delayInSeconds = 0.005;
     dispatch_time_t popTime = dispatch_time(DISPATCH_TIME_NOW, delayInSeconds * NSEC_PER_SEC);
     dispatch_after(popTime, dispatch_get_main_queue(), ^(void){
-        NSURL *callbackURL = [NSURL URLWithString:@"spotify-ios-sdk-beta://callback?access_token=NQpvC5h6MnausBFRG2hJjXifw2CZrXzQIh4S_SgBfpcVi6svpZKXpwYyoLRYhWN8g4L-zoZqYK0hfFNFgMqTpESGvodAuXGngZFiKc16y7oeMRJTZaY3&token_type=Bearer&expires_in=3600"];
+        NSURL *callbackURL = [NSURL URLWithString:@"test-url-scheme://callback?access_token=NQpvC5h6MnausBFRG2hJjXifw2CZrXzQIh4S_SgBfpcVi6svpZKXpwYyoLRYhWN8g4L-zoZqYK0hfFNFgMqTpESGvodAuXGngZFiKc16y7oeMRJTZaY3&token_type=Bearer&expires_in=3600"];
 
         [[NSNotificationCenter defaultCenter]
          postNotification:[NSNotification notificationWithName:CDVPluginHandleOpenURLNotification
@@ -159,7 +159,7 @@ - (void)testAuthenticateInvalidResponseType
 {
     __block BOOL responseArrived = NO;
 
-    [plugin authenticate:[self createTestURLCommand:@[@"spotify-ios-sdk-beta", @"bla", @[@"streaming"]]]];
+    [plugin authenticate:[self createTestURLCommand:@[@"test-url-scheme", @"aClientId", @"bla", @[@"streaming"]]]];
 
     [commandDelegate mockPluginResult:^(CDVPluginResult *result, NSString *callbackId) {
         XCTAssertEqual(result.status.intValue, CDVCommandStatus_ERROR, @"Command status should be ERROR");
@@ -184,7 +184,7 @@ - (void)testAuthenticateFailed
         return [OHHTTPStubsResponse responseWithError: errorForTesting()];
     }];
 
-    [plugin authenticate:[self createTestURLCommand:@[@"spotify-ios-sdk-beta", @"code", @"http://foo.bar:1234/swap", @[@"streaming"]]]];
+    [plugin authenticate:[self createTestURLCommand:@[@"test-url-scheme", @"clientId", @"code", @"http://foo.bar:1234/swap", @[@"streaming"]]]];
 
     [commandDelegate mockPluginResult:^(CDVPluginResult *result, NSString *callbackId) {
         XCTAssertEqual(result.status.intValue, CDVCommandStatus_ERROR, @"Command status should be ERROR");
@@ -194,7 +194,7 @@ - (void)testAuthenticateFailed
     double delayInSeconds = 0.005;
     dispatch_time_t popTime = dispatch_time(DISPATCH_TIME_NOW, delayInSeconds * NSEC_PER_SEC);
     dispatch_after(popTime, dispatch_get_main_queue(), ^(void){
-        NSURL *callbackURL = [NSURL URLWithString:@"spotify-ios-sdk-beta://callback?error=access_denied"];
+        NSURL *callbackURL = [NSURL URLWithString:@"test-url-scheme://callback?error=access_denied"];
 
         [[NSNotificationCenter defaultCenter]
          postNotification:[NSNotification notificationWithName:CDVPluginHandleOpenURLNotification

test/js/spec/spotify/auth.test.js

@@ -31,12 +31,12 @@ describe('auth', function() {
 
       describe('without scope', function() {
         beforeEach(function() {
-          spotify.authenticate('aRandomClientId1234', 'http://tok.en', this.callback);
+          spotify.authenticate('test-scheme', 'aRandomClientId1234', 'code', 'http://tok.en', this.callback);
         });
 
         it('should send the "streaming" scope to native', function() {
           expect(this.onRequest).to.have.been.calledWith([
-            'SpotifyPlugin', 'authenticate', ['aRandomClientId1234', 'http://tok.en', ['streaming']]
+            'SpotifyPlugin', 'authenticate', ['test-scheme', 'aRandomClientId1234', 'code', 'http://tok.en', ['streaming']]
           ]);
         });
 
@@ -47,12 +47,12 @@ describe('auth', function() {
 
       describe('with scope', function() {
         beforeEach(function() {
-          spotify.authenticate('aRandomClientId1234', 'http://tok.en', ['somescope'], this.callback);
+          spotify.authenticate('test-scheme', 'aRandomClientId1234', 'code', 'http://tok.en', ['somescope'], this.callback);
         });
 
         it('should send the "somescope" scope to native', function() {
           expect(this.onRequest).to.have.been.calledWith([
-            'SpotifyPlugin', 'authenticate', ['aRandomClientId1234', 'http://tok.en', ['somescope']]
+            'SpotifyPlugin', 'authenticate', ['test-scheme', 'aRandomClientId1234', 'code', 'http://tok.en', ['somescope']]
           ]);
         });
 
@@ -65,7 +65,7 @@ describe('auth', function() {
     describe('failed authentication', function() {
       beforeEach(function() {
         mockExec(9, 'Login to Spotify failed because of invalid credentials.', this.onRequest);
-        spotify.authenticate('aRandomClientId1234', 'http://tok.en', this.callback);
+        spotify.authenticate('test-scheme', 'aRandomClientId1234', 'code', 'http://tok.en', this.callback);
       });
 
       it('should send back "Login to Spotify failed because of invalid credentials."', function() {

www/spotify.js

@@ -4,7 +4,7 @@ var utils = require('./utils')
 
 var auth = exports;
 
-auth.authenticate = function(clientId, tokenExchangeURL, scopes, callback) {
+auth.authenticate = function(urlScheme, clientId, responseType, tokenExchangeURL, scopes, callback) {
   if (callback === undefined) {
     if (scopes === undefined) {
       callback = tokenExchangeURL;
@@ -16,7 +16,14 @@ auth.authenticate = function(clientId, tokenExchangeURL, scopes, callback) {
     scopes = ['streaming'];
   }
 
-  exec('authenticate', clientId, tokenExchangeURL, scopes, callback);
+  args = ['authenticate', urlScheme, clientId, responseType];
+
+  if(responseType == 'code') args.push(tokenExchangeURL);
+
+  args.push(scopes);
+  args.push(callback);
+
+  exec.apply(this, args);
 };
 
 auth.renewSession = function(session, tokenRefreshURL, forceRenew, callback) {