Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move base URLs out of resource services where possible #1490

Merged
merged 1 commit into from
Jan 28, 2019
Merged

Move base URLs out of resource services where possible #1490

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/Stripe.net/Services/Account/AccountService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,12 @@ public virtual Account Get(string accountId, RequestOptions requestOptions = nul

public virtual Account GetSelf(RequestOptions requestOptions = null)
{
return this.Request(HttpMethod.Get, $"{StripeConfiguration.ApiBase}/v1/account", null, requestOptions);
return this.Request(HttpMethod.Get, "/v1/account", null, requestOptions);
}

public virtual Task<Account> GetSelfAsync(RequestOptions requestOptions = null, CancellationToken cancellationToken = default(CancellationToken))
{
return this.RequestAsync(HttpMethod.Get, $"{StripeConfiguration.ApiBase}/v1/account", null, requestOptions, cancellationToken);
return this.RequestAsync(HttpMethod.Get, "/v1/account", null, requestOptions, cancellationToken);
}

public virtual StripeList<Account> List(AccountListOptions options = null, RequestOptions requestOptions = null)
Expand Down
8 changes: 4 additions & 4 deletions src/Stripe.net/Services/Discounts/DiscountService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,22 +20,22 @@ public DiscountService(string apiKey)

public virtual Discount DeleteCustomerDiscount(string customerId, RequestOptions requestOptions = null)
{
return this.Request(HttpMethod.Delete, $"{StripeConfiguration.ApiBase}/v1/customers/{customerId}/discount", null, requestOptions);
return this.Request(HttpMethod.Delete, $"/v1/customers/{customerId}/discount", null, requestOptions);
}

public virtual Task<Discount> DeleteCustomerDiscountAsync(string customerId, RequestOptions requestOptions = null, CancellationToken cancellationToken = default(CancellationToken))
{
return this.RequestAsync(HttpMethod.Delete, $"{StripeConfiguration.ApiBase}/v1/customers/{customerId}/discount", null, requestOptions, cancellationToken);
return this.RequestAsync(HttpMethod.Delete, $"/v1/customers/{customerId}/discount", null, requestOptions, cancellationToken);
}

public virtual Discount DeleteSubscriptionDiscount(string subscriptionId, RequestOptions requestOptions = null)
{
return this.Request(HttpMethod.Delete, $"{StripeConfiguration.ApiBase}/v1/subscriptions/{subscriptionId}/discount", null, requestOptions);
return this.Request(HttpMethod.Delete, $"/v1/subscriptions/{subscriptionId}/discount", null, requestOptions);
}

public virtual Task<Discount> DeleteSubscriptionDiscountAsync(string subscriptionId, RequestOptions requestOptions = null, CancellationToken cancellationToken = default(CancellationToken))
{
return this.RequestAsync(HttpMethod.Delete, $"{StripeConfiguration.ApiBase}/v1/subscriptions/{subscriptionId}/discount", null, requestOptions, cancellationToken);
return this.RequestAsync(HttpMethod.Delete, $"/v1/subscriptions/{subscriptionId}/discount", null, requestOptions, cancellationToken);
}
}
}
12 changes: 8 additions & 4 deletions src/Stripe.net/Services/Files/FileService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,22 +24,26 @@ public FileService(string apiKey)

public virtual File Create(FileCreateOptions options, RequestOptions requestOptions = null)
{
requestOptions = this.SetupRequestOptions(requestOptions);
requestOptions.BaseUrl = StripeConfiguration.FilesBase;
return Mapper<File>.MapFromJson(
Requestor.PostFile(
this.ClassUrl(StripeConfiguration.FilesBase),
StripeConfiguration.FilesBase + this.ClassUrl(),
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically, setting requestOptions.BaseUrl is useless here because the method doesn't call Service.Request. That's only temporary because Service.Request doesn't support multipart encoding yet, but I'll fix that later. In the meantime, this ensure that requestOptions.BaseUrl is consistent with the URL that is passed to Requestor.PostFile.

options.File,
options.Purpose,
this.SetupRequestOptions(requestOptions)));
requestOptions));
}

public virtual async Task<File> CreateAsync(FileCreateOptions options, RequestOptions requestOptions = null, CancellationToken cancellationToken = default(CancellationToken))
{
requestOptions = this.SetupRequestOptions(requestOptions);
requestOptions.BaseUrl = StripeConfiguration.FilesBase;
return Mapper<File>.MapFromJson(
await Requestor.PostFileAsync(
this.ClassUrl(StripeConfiguration.FilesBase),
StripeConfiguration.FilesBase + this.ClassUrl(),
options.File,
options.Purpose,
this.SetupRequestOptions(requestOptions),
requestOptions,
cancellationToken).ConfigureAwait(false));
}

Expand Down
10 changes: 6 additions & 4 deletions src/Stripe.net/Services/OAuth/OAuthTokenService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,24 +19,26 @@ public OAuthTokenService(string apiKey)

public override string BasePath => null;

public override string BaseUrl => StripeConfiguration.ConnectBase;

public virtual OAuthToken Create(OAuthTokenCreateOptions options, RequestOptions requestOptions = null)
{
return this.Request<OAuthToken>(HttpMethod.Post, $"{StripeConfiguration.ConnectBase}/oauth/token", options, requestOptions);
return this.Request(HttpMethod.Post, "/oauth/token", options, requestOptions);
}

public virtual Task<OAuthToken> CreateAsync(OAuthTokenCreateOptions options, RequestOptions requestOptions = null, CancellationToken cancellationToken = default(CancellationToken))
{
return this.RequestAsync<OAuthToken>(HttpMethod.Post, $"{StripeConfiguration.ConnectBase}/oauth/token", options, requestOptions, cancellationToken);
return this.RequestAsync(HttpMethod.Post, "/oauth/token", options, requestOptions, cancellationToken);
}

public virtual OAuthDeauthorize Deauthorize(OAuthTokenDeauthorizeOptions options, RequestOptions requestOptions = null)
{
return this.Request<OAuthDeauthorize>(HttpMethod.Post, $"{StripeConfiguration.ConnectBase}/oauth/deauthorize", options, requestOptions);
return this.Request<OAuthDeauthorize>(HttpMethod.Post, "/oauth/deauthorize", options, requestOptions);
}

public virtual Task<OAuthDeauthorize> DeauthorizeAsync(OAuthTokenDeauthorizeOptions options, RequestOptions requestOptions = null, CancellationToken cancellationToken = default(CancellationToken))
{
return this.RequestAsync<OAuthDeauthorize>(HttpMethod.Post, $"{StripeConfiguration.ConnectBase}/oauth/deauthorize", options, requestOptions, cancellationToken);
return this.RequestAsync<OAuthDeauthorize>(HttpMethod.Post, "/oauth/deauthorize", options, requestOptions, cancellationToken);
}
}
}
14 changes: 7 additions & 7 deletions src/Stripe.net/Services/Sources/SourceService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ public SourceService(string apiKey)

public virtual Source Attach(string customerId, SourceAttachOptions options, RequestOptions requestOptions = null)
{
return this.Request<Source>(HttpMethod.Post, $"{StripeConfiguration.ApiBase}/v1/customers/{customerId}/sources", options, requestOptions);
return this.Request<Source>(HttpMethod.Post, $"/v1/customers/{customerId}/sources", options, requestOptions);
}

public virtual Task<Source> AttachAsync(string customerId, SourceAttachOptions options, RequestOptions requestOptions = null, CancellationToken cancellationToken = default(CancellationToken))
{
return this.RequestAsync<Source>(HttpMethod.Post, $"{StripeConfiguration.ApiBase}/v1/customers/{customerId}/sources", options, requestOptions, cancellationToken);
return this.RequestAsync<Source>(HttpMethod.Post, $"/v1/customers/{customerId}/sources", options, requestOptions, cancellationToken);
}

public virtual Source Create(SourceCreateOptions options, RequestOptions requestOptions = null)
Expand All @@ -46,12 +46,12 @@ public virtual Source Create(SourceCreateOptions options, RequestOptions request

public virtual Source Detach(string customerId, string sourceId, RequestOptions requestOptions = null)
{
return this.Request<Source>(HttpMethod.Delete, $"{StripeConfiguration.ApiBase}/v1/customers/{customerId}/sources/{sourceId}", null, requestOptions);
return this.Request<Source>(HttpMethod.Delete, $"/v1/customers/{customerId}/sources/{sourceId}", null, requestOptions);
}

public virtual Task<Source> DetachAsync(string customerId, string sourceId, RequestOptions requestOptions = null, CancellationToken cancellationToken = default(CancellationToken))
{
return this.RequestAsync<Source>(HttpMethod.Delete, $"{StripeConfiguration.ApiBase}/v1/customers/{customerId}/sources/{sourceId}", null, requestOptions, cancellationToken);
return this.RequestAsync<Source>(HttpMethod.Delete, $"/v1/customers/{customerId}/sources/{sourceId}", null, requestOptions, cancellationToken);
}

public virtual Source Get(string sourceId, RequestOptions requestOptions = null)
Expand All @@ -76,17 +76,17 @@ public virtual Source Get(string sourceId, SourceGetOptions options, RequestOpti

public virtual StripeList<Source> List(string customerId, SourceListOptions options = null, RequestOptions requestOptions = null)
{
return this.Request<StripeList<Source>>(HttpMethod.Get, $"{StripeConfiguration.ApiBase}/v1/customers/{customerId}/sources", options, requestOptions);
return this.Request<StripeList<Source>>(HttpMethod.Get, $"/v1/customers/{customerId}/sources", options, requestOptions);
}

public virtual Task<StripeList<Source>> ListAsync(string customerId, SourceListOptions options = null, RequestOptions requestOptions = null, CancellationToken cancellationToken = default(CancellationToken))
{
return this.RequestAsync<StripeList<Source>>(HttpMethod.Get, $"{StripeConfiguration.ApiBase}/v1/customers/{customerId}/sources", options, requestOptions, cancellationToken);
return this.RequestAsync<StripeList<Source>>(HttpMethod.Get, $"/v1/customers/{customerId}/sources", options, requestOptions, cancellationToken);
}

public virtual IEnumerable<Source> ListAutoPaging(string customerId, SourceListOptions options = null, RequestOptions requestOptions = null)
{
return this.ListRequestAutoPaging<Source>($"{StripeConfiguration.ApiBase}/v1/customers/{customerId}/sources", options, requestOptions);
return this.ListRequestAutoPaging<Source>($"/v1/customers/{customerId}/sources", options, requestOptions);
}

public virtual Source Update(string sourceId, SourceUpdateOptions options, RequestOptions requestOptions = null)
Expand Down
16 changes: 10 additions & 6 deletions src/Stripe.net/Services/_base/Service.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ protected Service(string apiKey)

public abstract string BasePath { get; }

public virtual string BaseUrl => StripeConfiguration.ApiBase;

protected EntityReturned CreateEntity(BaseOptions options, RequestOptions requestOptions)
{
return this.Request(
Expand Down Expand Up @@ -207,8 +209,9 @@ protected async Task<T> RequestAsync<T>(
where T : IStripeEntity
{
requestOptions = this.SetupRequestOptions(requestOptions);
var url = requestOptions.BaseUrl + path;
var wr = Requestor.GetRequestMessage(
this.ApplyAllParameters(options, path, IsStripeList<T>()),
this.ApplyAllParameters(options, url, IsStripeList<T>()),
method,
requestOptions);
return Mapper<T>.MapFromJson(await Requestor.ExecuteRequestAsync(wr));
Expand Down Expand Up @@ -261,18 +264,19 @@ protected RequestOptions SetupRequestOptions(RequestOptions requestOptions)
requestOptions.ApiKey = this.ApiKey;
}

requestOptions.BaseUrl = requestOptions.BaseUrl ?? this.BaseUrl;

return requestOptions;
}

protected virtual string ClassUrl(string baseUrl = null)
protected virtual string ClassUrl()
{
baseUrl = baseUrl ?? StripeConfiguration.ApiBase;
return $"{baseUrl}{this.BasePath}";
return this.BasePath;
}

protected virtual string InstanceUrl(string id, string baseUrl = null)
protected virtual string InstanceUrl(string id)
{
return $"{this.ClassUrl(baseUrl)}/{WebUtility.UrlEncode(id)}";
return $"{this.ClassUrl()}/{WebUtility.UrlEncode(id)}";
}

private static bool IsStripeList<T>()
Expand Down
9 changes: 4 additions & 5 deletions src/Stripe.net/Services/_base/ServiceNested.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,15 +166,14 @@ protected Task<EntityReturned> UpdateNestedEntityAsync(
cancellationToken);
}

protected virtual string ClassUrl(string parentId, string baseUrl = null)
protected virtual string ClassUrl(string parentId)
{
baseUrl = baseUrl ?? StripeConfiguration.ApiBase;
return $"{baseUrl}{this.BasePath.Replace("{PARENT_ID}", parentId)}";
return this.BasePath.Replace("{PARENT_ID}", parentId);
}

protected virtual string InstanceUrl(string parentId, string id, string baseUrl = null)
protected virtual string InstanceUrl(string parentId, string id)
{
return $"{this.ClassUrl(parentId, baseUrl)}/{WebUtility.UrlEncode(id)}";
return $"{this.ClassUrl(parentId)}/{WebUtility.UrlEncode(id)}";
}
}
}
8 changes: 8 additions & 0 deletions src/Stripe.net/Services/_common/RequestOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,14 @@ public class RequestOptions
/// <summary>For Connect requests, the connected account's ID.</summary>
public string StripeConnectAccountId { get; set; }

/// <summary>The base URL for the request.</summary>
/// <remarks>
/// This is an internal property. It is set by services or individual request methods when
/// they need to send a request to a non-standard destination, e.g. <c>files.stripe.com</c>
/// for file creation requests or <c>connect.stripe.com</c> for OAuth requests.
/// </remarks>
internal string BaseUrl { get; set; }

/// <summary>The API version for the request.</summary>
/// <remarks>
/// This is an internal property. For most requests, the API version is always set to the
Expand Down