Skip to content

Commit

Permalink
Deprecate SourceCallback and TokenCallback (#1327)
Browse files Browse the repository at this point in the history 
Use `ApiResultCallback<ResultType>` instead
  • Loading branch information
@mshafrir-stripe
mshafrir-stripe authored Aug 7, 2019
1 parent f1eec10 commit 664c8f2
Show file tree
Hide file tree
Showing 7 changed files with 67 additions and 53 deletions.
6 changes: 3 additions & 3 deletions example/src/main/java/com/stripe/example/controller/AsyncTaskTokenController.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ package com.stripe.example.controller

import android.content.Context
import android.widget.Button
import com.stripe.android.ApiResultCallback
import com.stripe.android.Stripe
import com.stripe.android.TokenCallback
import com.stripe.android.model.Token
import com.stripe.android.view.CardInputWidget
import com.stripe.example.R
Expand Down Expand Up @@ -37,7 +37,7 @@ class AsyncTaskTokenController(
mCardInputWidget = null
}

private fun saveCard(tokenCallback: TokenCallback) {
private fun saveCard(tokenCallback: ApiResultCallback<Token>) {
val cardToSave = mCardInputWidget?.card
if (cardToSave == null) {
mErrorDialogHandler.show("Invalid Card Data")
Expand All @@ -52,7 +52,7 @@ class AsyncTaskTokenController(
private val mErrorDialogHandler: ErrorDialogHandler,
private val mOutputListController: ListViewController,
private val mProgressDialogController: ProgressDialogController
) : TokenCallback {
) : ApiResultCallback<Token> {
override fun onSuccess(token: Token) {
mOutputListController.addToList(token)
mProgressDialogController.dismiss()
Expand Down
9 changes: 6 additions & 3 deletions stripe/src/main/java/com/stripe/android/ActivitySourceCallback.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,16 @@
import android.support.annotation.NonNull;
import android.support.annotation.Nullable;

import com.stripe.android.model.Source;

import java.lang.ref.WeakReference;

/**
* Abstract implementation of {@link SourceCallback} that holds a {@link WeakReference} to
* an {@link Activity} object.
* Abstract implementation of {@link ApiResultCallback<Source>} that holds a {@link WeakReference}
* to an {@link Activity} object.
*/
public abstract class ActivitySourceCallback<A extends Activity> implements SourceCallback {
public abstract class ActivitySourceCallback<A extends Activity>
implements ApiResultCallback<Source> {
@NonNull private final WeakReference<A> mActivityRef;

public ActivitySourceCallback(@NonNull A activity) {
Expand Down
3 changes: 3 additions & 0 deletions stripe/src/main/java/com/stripe/android/SourceCallback.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
/**
* An interface representing a callback to be notified about the results of
* creating or finding a {@link Source}.
*
* @deprecated use {@link ApiResultCallback<Source>}
*/
@Deprecated
public interface SourceCallback extends ApiResultCallback<Source> {
}
64 changes: 33 additions & 31 deletions stripe/src/main/java/com/stripe/android/Stripe.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ public void create(
@NonNull final ApiRequest.Options options,
@NonNull @Token.TokenType final String tokenType,
@Nullable final Executor executor,
@NonNull final TokenCallback callback) {
@NonNull final ApiResultCallback<Token> callback) {
executeTask(executor,
new CreateTokenTask(apiHandler, tokenParams, options,
tokenType, callback));
Expand Down Expand Up @@ -402,11 +402,11 @@ public boolean onSetupResult(int requestCode, @Nullable Intent data,
* {@link Executor} and with the currently set {@link #mDefaultPublishableKey}.
*
* @param bankAccount the {@link BankAccount} used to create this token
* @param callback a {@link TokenCallback} to receive either the token or an error
* @param callback a {@link ApiResultCallback<Token>} to receive either the token or an error
*/
public void createBankAccountToken(
@NonNull final BankAccount bankAccount,
@NonNull final TokenCallback callback) {
@NonNull final ApiResultCallback<Token> callback) {
createBankAccountToken(bankAccount, mDefaultPublishableKey, null, callback);
}

Expand All @@ -418,13 +418,13 @@ public void createBankAccountToken(
* @param publishableKey the publishable key to use
* @param executor an {@link Executor} to run this operation on. If null, this is run on a
* default non-ui executor
* @param callback a {@link TokenCallback} to receive the result or error message
* @param callback a {@link ApiResultCallback<Token>} to receive the result or error message
*/
public void createBankAccountToken(
@NonNull final BankAccount bankAccount,
@NonNull @Size(min = 1) final String publishableKey,
@Nullable final Executor executor,
@NonNull final TokenCallback callback) {
@NonNull final ApiResultCallback<Token> callback) {
Objects.requireNonNull(bankAccount,

"Required parameter: 'bankAccount' is requred to create a token");
Expand All @@ -442,11 +442,11 @@ public void createBankAccountToken(
* {@link Executor} and with the currently set {@link #mDefaultPublishableKey}.
*
* @param personalId the personal id used to create this token
* @param callback a {@link TokenCallback} to receive either the token or an error
* @param callback a {@link ApiResultCallback<Token>} to receive either the token or an error
*/
public void createPiiToken(
@NonNull final String personalId,
@NonNull final TokenCallback callback) {
@NonNull final ApiResultCallback<Token> callback) {
createPiiToken(personalId, mDefaultPublishableKey, null, callback);
}

Expand All @@ -458,13 +458,13 @@ public void createPiiToken(
* @param publishableKey the publishable key to use
* @param executor an {@link Executor} to run this operation on. If null, this is run on a
* default non-ui executor
* @param callback a {@link TokenCallback} to receive the result or error message
* @param callback a {@link ApiResultCallback<Token>} to receive the result or error message
*/
public void createPiiToken(
@NonNull final String personalId,
@NonNull @Size(min = 1) final String publishableKey,
@Nullable final Executor executor,
@NonNull final TokenCallback callback) {
@NonNull final ApiResultCallback<Token> callback) {
createTokenFromParams(
createPersonalIdTokenParams(personalId),
publishableKey,
Expand Down Expand Up @@ -533,11 +533,11 @@ public Token createBankAccountTokenSynchronous(@NonNull final BankAccount bankAc
* {@link Executor} and with the currently set {@link #mDefaultPublishableKey}.
*
* @param cvc the CVC used to create this token
* @param callback a {@link TokenCallback} to receive either the token or an error
* @param callback a {@link ApiResultCallback<Token>} to receive either the token or an error
*/
public void createCvcUpdateToken(
@NonNull @Size(min = 3, max = 4) final String cvc,
@NonNull final TokenCallback callback) {
@NonNull final ApiResultCallback<Token> callback) {
createCvcUpdateToken(cvc, mDefaultPublishableKey, null, callback);
}

Expand All @@ -549,13 +549,13 @@ public void createCvcUpdateToken(
* @param publishableKey the publishable key to use
* @param executor an {@link Executor} to run this operation on. If null, this is run on a
* default non-ui executor
* @param callback a {@link TokenCallback} to receive the result or error message
* @param callback a {@link ApiResultCallback<Token>} to receive the result or error message
*/
public void createCvcUpdateToken(
@NonNull @Size(min = 3, max = 4) final String cvc,
@NonNull @Size(min = 1) final String publishableKey,
@Nullable final Executor executor,
@NonNull final TokenCallback callback) {
@NonNull final ApiResultCallback<Token> callback) {
createTokenFromParams(
createUpdateCvcTokenParams(cvc),
publishableKey,
Expand All @@ -569,23 +569,24 @@ public void createCvcUpdateToken(
* publishable api key that has already been set on this {@link Stripe} instance.
*
* @param sourceParams the {@link SourceParams} to be used
* @param callback a {@link SourceCallback} to receive a result or an error message
* @param callback a {@link ApiResultCallback<Source>} to receive a result or an error message
*/
public void createSource(@NonNull SourceParams sourceParams, @NonNull SourceCallback callback) {
public void createSource(@NonNull SourceParams sourceParams,
@NonNull ApiResultCallback<Source> callback) {
createSource(sourceParams, callback, mDefaultPublishableKey, null);
}

/**
* Create a {@link Source} using an {@link AsyncTask}.
*
* @param sourceParams the {@link SourceParams} to be used
* @param callback a {@link SourceCallback} to receive a result or an error message
* @param callback a {@link ApiResultCallback<Source>} to receive a result or an error message
* @param publishableKey the publishable api key to be used
* @param executor an {@link Executor} on which to execute the task, or {@link null} for default
*/
public void createSource(
@NonNull SourceParams sourceParams,
@NonNull SourceCallback callback,
@NonNull ApiResultCallback<Source> callback,
@NonNull String publishableKey,
@Nullable Executor executor) {
executeTask(executor,
Expand Down Expand Up @@ -625,14 +626,15 @@ public void createPaymentMethod(
}

/**
* The simplest way to create a token, using a {@link Card} and {@link TokenCallback}. This
* runs on the default {@link Executor} and with the
* The simplest way to create a token, using a {@link Card} and
* {@link ApiResultCallback<Token>}. This runs on the default {@link Executor} and with the
* currently set {@link #mDefaultPublishableKey}.
*
* @param card the {@link Card} used to create this payment token
* @param callback a {@link TokenCallback} to receive either the token or an error
* @param callback a {@link ApiResultCallback<Token>} to receive either the token or an error
*/
public void createToken(@NonNull final Card card, @NonNull final TokenCallback callback) {
public void createToken(@NonNull final Card card,
@NonNull final ApiResultCallback<Token> callback) {
createToken(card, mDefaultPublishableKey, callback);
}

Expand All @@ -641,12 +643,12 @@ public void createToken(@NonNull final Card card, @NonNull final TokenCallback c
*
* @param card the {@link Card} used for this transaction
* @param publishableKey the public key used for this transaction
* @param callback a {@link TokenCallback} to receive the result of this operation
* @param callback a {@link ApiResultCallback<Token>} to receive the result of this operation
*/
public void createToken(
@NonNull final Card card,
@NonNull final String publishableKey,
@NonNull final TokenCallback callback) {
@NonNull final ApiResultCallback<Token> callback) {
createToken(card, publishableKey, null, callback);
}

Expand All @@ -656,12 +658,12 @@ public void createToken(
* @param card the {@link Card} to use for this token creation
* @param executor An {@link Executor} on which to run this operation. If you don't wish to
* specify an executor, use one of the other createTokenFromParams methods.
* @param callback a {@link TokenCallback} to receive the result of this operation
* @param callback a {@link ApiResultCallback<Token>} to receive the result of this operation
*/
public void createToken(
@NonNull final Card card,
@NonNull final Executor executor,
@NonNull final TokenCallback callback) {
@NonNull final ApiResultCallback<Token> callback) {
createToken(card, mDefaultPublishableKey, executor, callback);
}

Expand All @@ -672,13 +674,13 @@ public void createToken(
* @param publishableKey the publishable key to use
* @param executor an {@link Executor} to run this operation on. If null, this is run on a
* default non-ui executor
* @param callback a {@link TokenCallback} to receive the result or error message
* @param callback a {@link ApiResultCallback<Token>} to receive the result or error message
*/
public void createToken(
@NonNull final Card card,
@NonNull @Size(min = 1) final String publishableKey,
@Nullable final Executor executor,
@NonNull final TokenCallback callback) {
@NonNull final ApiResultCallback<Token> callback) {
Objects.requireNonNull(card,
"Required Parameter: 'card' is required to create a token");

Expand Down Expand Up @@ -1171,7 +1173,7 @@ private void createTokenFromParams(
@NonNull @Size(min = 1) final String publishableKey,
@NonNull @Token.TokenType final String tokenType,
@Nullable final Executor executor,
@NonNull final TokenCallback callback) {
@NonNull final ApiResultCallback<Token> callback) {
Objects.requireNonNull(callback,
"Required Parameter: 'callback' is required to use the created " +
"token and handle errors");
Expand All @@ -1197,7 +1199,7 @@ void create(@NonNull Map<String, Object> params,
@NonNull ApiRequest.Options options,
@NonNull @Token.TokenType String tokenType,
@Nullable Executor executor,
@NonNull TokenCallback callback);
@NonNull ApiResultCallback<Token> callback);
}

private static class CreateSourceTask extends ApiOperation<Source> {
Expand All @@ -1209,7 +1211,7 @@ private static class CreateSourceTask extends ApiOperation<Source> {
@NonNull SourceParams sourceParams,
@NonNull String publishableKey,
@Nullable String stripeAccount,
@NonNull SourceCallback callback) {
@NonNull ApiResultCallback<Source> callback) {
super(callback);
mApiHandler = apiHandler;
mSourceParams = sourceParams;
Expand Down Expand Up @@ -1257,7 +1259,7 @@ private static class CreateTokenTask extends ApiOperation<Token> {
@NonNull final Map<String, Object> tokenParams,
@NonNull final ApiRequest.Options options,
@NonNull @Token.TokenType final String tokenType,
@NonNull final TokenCallback callback) {
@NonNull final ApiResultCallback<Token> callback) {
super(callback);
mApiHandler = apiHandler;
mTokenParams = tokenParams;
Expand Down
3 changes: 3 additions & 0 deletions stripe/src/main/java/com/stripe/android/TokenCallback.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
/**
* An interface representing a callback to be notified about the results of
* {@link Token} creation or requests
*
* @deprecated use {@link ApiResultCallback<Token>}
*/
@Deprecated
public interface TokenCallback extends ApiResultCallback<Token> {
}
34 changes: 18 additions & 16 deletions stripe/src/test/java/com/stripe/android/StripeTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,14 +63,16 @@ public class StripeTest {
private static final String DEFAULT_SECRET_KEY = "sk_default";

private static final Card DEFAULT_CARD = Card.create(null, null, null, null);
private static final TokenCallback DEFAULT_TOKEN_CALLBACK = new TokenCallback() {
@Override
public void onError(@NonNull Exception error) {
}
@Override
public void onSuccess(@NonNull Token token) {
}
};
private static final ApiResultCallback<Token> DEFAULT_TOKEN_CALLBACK =
new ApiResultCallback<Token>() {
@Override
public void onError(@NonNull Exception error) {
}

@Override
public void onSuccess(@NonNull Token token) {
}
};

private static final String TEST_CARD_NUMBER = "4242424242424242";
private static final String TEST_BANK_ACCOUNT_NUMBER = "000123456789";
Expand Down Expand Up @@ -207,7 +209,7 @@ public void run() {
@Test(expected = IllegalArgumentException.class)
public void createTokenShouldFailWithNullPublishableKey() {
new Stripe(mContext)
.createToken(DEFAULT_CARD, new TokenCallback() {
.createToken(DEFAULT_CARD, new ApiResultCallback<Token>() {
@Override
public void onError(@NonNull Exception error) {
fail("Should not call method");
Expand All @@ -230,7 +232,7 @@ public void create(@NonNull Map<String, Object> tokenParams,
@NonNull ApiRequest.Options requestOptions,
@NonNull @Token.TokenType String tokenType,
@Nullable Executor executor,
@NonNull TokenCallback callback) {
@NonNull ApiResultCallback<Token> callback) {
tokenCreatorCalled[0] = true;
}
});
Expand All @@ -252,7 +254,7 @@ public void create(@NonNull Map<String, Object> tokenParams,
@NonNull ApiRequest.Options requestOptions,
@NonNull @Token.TokenType String tokenType,
@Nullable Executor executor,
@NonNull TokenCallback callback) {
@NonNull ApiResultCallback<Token> callback) {
assertEquals(expectedExecutor, executor);
assertEquals(NON_LOGGING_PK, requestOptions.apiKey);
assertEquals(DEFAULT_TOKEN_CALLBACK, callback);
Expand All @@ -270,7 +272,7 @@ public void create(@NonNull Map<String, Object> tokenParams,
@NonNull ApiRequest.Options requestOptions,
@NonNull @Token.TokenType String tokenType,
@Nullable Executor executor,
@NonNull TokenCallback callback) {
@NonNull ApiResultCallback<Token> callback) {
assertEquals(NON_LOGGING_PK, requestOptions.apiKey);
assertNull(executor);
assertEquals(DEFAULT_TOKEN_CALLBACK, callback);
Expand Down Expand Up @@ -358,7 +360,7 @@ public void createBankAccountToken() {
"1JWtPxqbdX5Gamtc",
"6789",
"110000000"),
new TokenCallback() {
new ApiResultCallback<Token>() {
@Override
public void onSuccess(@NonNull Token result) {
}
Expand All @@ -372,7 +374,7 @@ public void onError(@NonNull Exception e) {
@Test
public void createPiiToken() {
createNonLoggingStripe().createPiiToken("123-45-6789",
new TokenCallback() {
new ApiResultCallback<Token>() {
@Override
public void onSuccess(@NonNull Token result) {

Expand All @@ -388,7 +390,7 @@ public void onError(@NonNull Exception e) {
@Test
public void createSource() {
createNonLoggingStripe().createSource(CARD_SOURCE_PARAMS,
new SourceCallback() {
new ApiResultCallback<Source>() {
@Override
public void onSuccess(@NonNull Source result) {

Expand All @@ -404,7 +406,7 @@ public void onError(@NonNull Exception e) {
@Test
public void createCvcUpdateToken() {
createNonLoggingStripe().createCvcUpdateToken("123",
new TokenCallback() {
new ApiResultCallback<Token>() {
@Override
public void onSuccess(@NonNull Token result) {

Expand Down
Loading

0 comments on commit 664c8f2

Please sign in to comment.