Skip to content

Commit d992c8a

Browse files
RoblindeRoblinde
authored
Add base url to public api (#336)
1 parent 0f6b684 commit d992c8a

File tree

5 files changed

+53
-22
lines changed

5 files changed

+53
-22
lines changed

‎Contentful.AspNetCore/Contentful.AspNetCore.csproj

+5-5
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<Description>Official .NET SDK for the Contentful Content Delivery and Management API for ASP.NET core.</Description>
44
<PackageId>contentful.aspnetcore</PackageId>
55
<NeutralLanguage>en-US</NeutralLanguage>
6-
<VersionPrefix>7.5.2</VersionPrefix>
6+
<VersionPrefix>7.5.3</VersionPrefix>
77
<TargetFramework>netstandard2.0</TargetFramework>
88
<Authors>Contentful</Authors>
99
<Copyright>Contentful GmbH.</Copyright>
@@ -13,10 +13,10 @@
1313
<PackageProjectUrl>https://github.com/contentful/contentful.net</PackageProjectUrl>
1414
<PackageLicenseExpression>MIT</PackageLicenseExpression>
1515
<RepositoryType>git</RepositoryType>
16-
<Version>7.5.2</Version>
17-
<AssemblyVersion>7.5.2.0</AssemblyVersion>
16+
<Version>7.5.3</Version>
17+
<AssemblyVersion>7.5.3.0</AssemblyVersion>
1818
<RepositoryUrl>https://github.com/contentful/contentful.net</RepositoryUrl>
19-
<FileVersion>7.5.2.0</FileVersion>
19+
<FileVersion>7.5.3.0</FileVersion>
2020
</PropertyGroup>
2121
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
2222
<DocumentationFile>bin\Release\netstandard1.5\Contentful.AspNetCore.xml</DocumentationFile>
@@ -25,7 +25,7 @@
2525
<AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
2626
</PropertyGroup>
2727
<ItemGroup>
28-
<PackageReference Include="contentful.csharp" Version="7.5.2" />
28+
<PackageReference Include="contentful.csharp" Version="7.5.3" />
2929
<PackageReference Include="Microsoft.AspNetCore.Http" Version="2.2.2" />
3030
<PackageReference Include="Microsoft.AspNetCore.Http.Abstractions" Version="2.2.0" />
3131
<PackageReference Include="Microsoft.AspNetCore.Mvc.Razor" Version="2.2.0" />

‎Contentful.Core.Tests/ContentfulClientTests.cs

+21
Original file line numberDiff line numberDiff line change
@@ -439,6 +439,27 @@ public async Task GetEntriesShouldSerializeCorrectlyToAnEnumerableOfArbitraryTyp
439439
Assert.Equal("Mike Springer", res.First().Cross.Name);
440440
}
441441

442+
[Fact]
443+
public async Task SettingsBaseUrlShouldCallNewUrl()
444+
{
445+
//Arrange
446+
_handler.Response = GetResponseFromFile(@"EntriesCollection.json");
447+
var baseUrl = "";
448+
_handler.VerifyRequest = (HttpRequestMessage request) =>
449+
{
450+
baseUrl = request.RequestUri.ToString();
451+
};
452+
453+
_client.BaseUrl = "https://robertlinde.se/";
454+
//Act
455+
var res = await _client.GetEntries<TestEntryModel>();
456+
457+
//Assert
458+
Assert.Equal(9, res.Count());
459+
Assert.Equal("https://robertlinde.se/666/entries", baseUrl);
460+
461+
}
462+
442463
[Fact]
443464
public async Task GetEntriesShouldSerializeCorrectlyToAnEnumerableOfArbitraryTypeWithSystemProperties()
444465
{

‎Contentful.Core/Contentful.Core.csproj

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<PackageId>contentful.csharp</PackageId>
55
<AssemblyTitle>contentful.net</AssemblyTitle>
66
<NeutralLanguage>en-US</NeutralLanguage>
7-
<VersionPrefix>7.5.2</VersionPrefix>
7+
<VersionPrefix>7.5.3</VersionPrefix>
88
<TargetFramework>netstandard2.0</TargetFramework>
99
<Authors>Contentful</Authors>
1010
<Copyright>Contentful GmbH.</Copyright>

‎Contentful.Core/ContentfulClient.cs

+21-16
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ namespace Contentful.Core
2323
/// </summary>
2424
public class ContentfulClient : ContentfulClientBase, IContentfulClient
2525
{
26-
private readonly string _baseUrl = "https://cdn.contentful.com/spaces/";
26+
private string _baseUrl = "https://cdn.contentful.com/spaces/";
2727

2828
/// <summary>
2929
/// Initializes a new instance of the <see cref="ContentfulClient"/> class.
@@ -44,7 +44,7 @@ public ContentfulClient(HttpClient httpClient, ContentfulOptions options)
4444

4545
if (_options.UsePreviewApi)
4646
{
47-
_baseUrl = _baseUrl.Replace("cdn", "preview");
47+
BaseUrl = BaseUrl.Replace("cdn", "preview");
4848
}
4949
ResolveEntriesSelectively = _options.ResolveEntriesSelectively;
5050
SerializerSettings.Converters.Add(new AssetJsonConverter());
@@ -94,6 +94,11 @@ public ContentfulClient(HttpClient httpClient, string deliveryApiKey, string pre
9494
/// </summary>
9595
public List<CrossSpaceResolutionSetting> CrossSpaceResolutionSettings { get; set; } = new List<CrossSpaceResolutionSetting>();
9696

97+
/// <summary>
98+
/// The base url used when calling the Contentful services. Defaults to https://cdn.contentful.com/spaces/
99+
/// </summary>
100+
public string BaseUrl { get => _baseUrl; set => _baseUrl = value; }
101+
97102
/// <summary>
98103
/// Get a single entry by the specified ID.
99104
/// </summary>
@@ -130,7 +135,7 @@ public async Task<ContentfulResult<T>> GetEntry<T>(string entryId, string etag,
130135
throw new ArgumentException(nameof(entryId));
131136
}
132137

133-
var res = await Get($"{_baseUrl}{_options.SpaceId}/{EnvironmentsBase}entries/{entryId}{queryString}", etag, cancellationToken, CrossSpaceResolutionSettings).ConfigureAwait(false);
138+
var res = await Get($"{BaseUrl}{_options.SpaceId}/{EnvironmentsBase}entries/{entryId}{queryString}", etag, cancellationToken, CrossSpaceResolutionSettings).ConfigureAwait(false);
134139

135140
if(!string.IsNullOrEmpty(etag) && res.Headers?.ETag?.Tag == etag)
136141
{
@@ -214,14 +219,14 @@ public async Task<ContentfulCollection<T>> GetEntries<T>(QueryBuilder<T> queryBu
214219

215220
public async Task<string> GetEntriesRaw(string queryString = null, CancellationToken cancellationToken = default)
216221
{
217-
var res = await Get($"{_baseUrl}{_options.SpaceId}/{EnvironmentsBase}entries{queryString}", null, cancellationToken, CrossSpaceResolutionSettings).ConfigureAwait(false);
222+
var res = await Get($"{BaseUrl}{_options.SpaceId}/{EnvironmentsBase}entries{queryString}", null, cancellationToken, CrossSpaceResolutionSettings).ConfigureAwait(false);
218223
var resultString = await res.Content.ReadAsStringAsync().ConfigureAwait(false);
219224
return resultString;
220225
}
221226

222227
public async Task<ContentfulResult<ContentfulCollection<T>>> GetEntries<T>(string etag, string queryString = null, CancellationToken cancellationToken = default)
223228
{
224-
var res = await Get($"{_baseUrl}{_options.SpaceId}/{EnvironmentsBase}entries{queryString}", etag, cancellationToken, CrossSpaceResolutionSettings).ConfigureAwait(false);
229+
var res = await Get($"{BaseUrl}{_options.SpaceId}/{EnvironmentsBase}entries{queryString}", etag, cancellationToken, CrossSpaceResolutionSettings).ConfigureAwait(false);
225230

226231
if (!string.IsNullOrEmpty(etag) && res.Headers?.ETag.Tag == etag)
227232
{
@@ -494,7 +499,7 @@ public async Task<ContentfulResult<Asset>> GetAsset(string assetId, string etag,
494499
throw new ArgumentException(nameof(assetId));
495500
}
496501

497-
var res = await Get($"{_baseUrl}{_options.SpaceId}/{EnvironmentsBase}assets/{assetId}{queryString}", etag, cancellationToken, null).ConfigureAwait(false);
502+
var res = await Get($"{BaseUrl}{_options.SpaceId}/{EnvironmentsBase}assets/{assetId}{queryString}", etag, cancellationToken, null).ConfigureAwait(false);
498503

499504
if (!string.IsNullOrEmpty(etag) && res.Headers?.ETag?.Tag == etag)
500505
{
@@ -545,7 +550,7 @@ public async Task<ContentfulCollection<Asset>> GetAssets(QueryBuilder<Asset> que
545550
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
546551
public async Task<ContentfulResult<ContentfulCollection<Asset>>> GetAssets(string etag, string queryString = null, CancellationToken cancellationToken = default)
547552
{
548-
var res = await Get($"{_baseUrl}{_options.SpaceId}/{EnvironmentsBase}assets/{queryString}", etag, cancellationToken, null).ConfigureAwait(false);
553+
var res = await Get($"{BaseUrl}{_options.SpaceId}/{EnvironmentsBase}assets/{queryString}", etag, cancellationToken, null).ConfigureAwait(false);
549554

550555
if (!string.IsNullOrEmpty(etag) && res.Headers?.ETag?.Tag == etag)
551556
{
@@ -595,7 +600,7 @@ public async Task<EmbargoedAssetKey> CreateEmbargoedAssetKey(DateTimeOffset time
595600

596601
var expiresAt = timeOffset.ToUnixTimeSeconds();
597602
//note that unlike some other api methods, the asset embargo key always requires an environment id.
598-
var res = await Post($"{_baseUrl}{_options.SpaceId}/{(EnvironmentsBase == string.Empty ? "environments/master/" : EnvironmentsBase)}asset_keys", new { expiresAt }, cancellationToken).ConfigureAwait(false);
603+
var res = await Post($"{BaseUrl}{_options.SpaceId}/{(EnvironmentsBase == string.Empty ? "environments/master/" : EnvironmentsBase)}asset_keys", new { expiresAt }, cancellationToken).ConfigureAwait(false);
599604

600605
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
601606
var assetKey = jsonObject.ToObject<EmbargoedAssetKey>(Serializer);
@@ -611,7 +616,7 @@ public async Task<EmbargoedAssetKey> CreateEmbargoedAssetKey(DateTimeOffset time
611616
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
612617
public async Task<ContentfulResult<Space>> GetSpace(string etag, CancellationToken cancellationToken = default)
613618
{
614-
var res = await Get($"{_baseUrl}{_options.SpaceId}", etag, cancellationToken, null).ConfigureAwait(false);
619+
var res = await Get($"{BaseUrl}{_options.SpaceId}", etag, cancellationToken, null).ConfigureAwait(false);
615620

616621
if (!string.IsNullOrEmpty(etag) && res.Headers?.ETag?.Tag == etag)
617622
{
@@ -653,7 +658,7 @@ public async Task<ContentfulResult<ContentType>> GetContentType(string etag, str
653658
throw new ArgumentException(nameof(contentTypeId));
654659
}
655660

656-
var res = await Get($"{_baseUrl}{_options.SpaceId}/{EnvironmentsBase}content_types/{contentTypeId}", etag, cancellationToken, null).ConfigureAwait(false);
661+
var res = await Get($"{BaseUrl}{_options.SpaceId}/{EnvironmentsBase}content_types/{contentTypeId}", etag, cancellationToken, null).ConfigureAwait(false);
657662

658663
if (!string.IsNullOrEmpty(etag) && res.Headers?.ETag?.Tag == etag)
659664
{
@@ -673,7 +678,7 @@ public async Task<ContentfulResult<ContentType>> GetContentType(string etag, str
673678
/// <returns>An <see cref="IEnumerable{T}"/> of <see cref="ContentTag"/>.</returns>
674679
public async Task<IEnumerable<ContentTag>> GetTags(string queryString = "", CancellationToken cancellationToken = default) {
675680

676-
var res = await Get($"{_baseUrl}{_options.SpaceId}/{EnvironmentsBase}tags/{queryString}", null, cancellationToken, null).ConfigureAwait(false);
681+
var res = await Get($"{BaseUrl}{_options.SpaceId}/{EnvironmentsBase}tags/{queryString}", null, cancellationToken, null).ConfigureAwait(false);
677682

678683
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
679684
var tags = jsonObject.SelectTokens("$..items[*]").Select(t => t.ToObject<ContentTag>(Serializer));
@@ -694,7 +699,7 @@ public async Task<ContentTag> GetTag(string tagId, CancellationToken cancellatio
694699
throw new ArgumentException(nameof(tagId));
695700
}
696701

697-
var res = await Get($"{_baseUrl}{_options.SpaceId}/{EnvironmentsBase}tags/{tagId}", null, cancellationToken, null).ConfigureAwait(false);
702+
var res = await Get($"{BaseUrl}{_options.SpaceId}/{EnvironmentsBase}tags/{tagId}", null, cancellationToken, null).ConfigureAwait(false);
698703

699704
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
700705
var tag = jsonObject.ToObject<ContentTag>(Serializer);
@@ -735,7 +740,7 @@ public async Task<IEnumerable<ContentType>> GetContentTypes(CancellationToken ca
735740
/// <returns>An <see cref="IEnumerable{T}"/> of <see cref="ContentType"/>.</returns>
736741
public async Task<ContentfulResult<IEnumerable<ContentType>>> GetContentTypes(string etag, string queryString, CancellationToken cancellationToken = default)
737742
{
738-
var res = await Get($"{_baseUrl}{_options.SpaceId}/{EnvironmentsBase}content_types/{queryString}", etag, cancellationToken, null).ConfigureAwait(false);
743+
var res = await Get($"{BaseUrl}{_options.SpaceId}/{EnvironmentsBase}content_types/{queryString}", etag, cancellationToken, null).ConfigureAwait(false);
739744

740745
if (!string.IsNullOrEmpty(etag) && res.Headers?.ETag?.Tag == etag)
741746
{
@@ -768,7 +773,7 @@ public async Task<IEnumerable<ContentType>> GetContentTypes(string queryString,
768773
/// <returns>An <see cref="IEnumerable{T}"/> of <see cref="Locale"/>.</returns>
769774
public async Task<ContentfulResult<IEnumerable<Locale>>> GetLocales(string etag, CancellationToken cancellationToken = default)
770775
{
771-
var res = await Get($"{_baseUrl}{_options.SpaceId}/{(string.IsNullOrEmpty(EnvironmentsBase) ? "environments/master/" : EnvironmentsBase)}locales/", etag, cancellationToken, null).ConfigureAwait(false);
776+
var res = await Get($"{BaseUrl}{_options.SpaceId}/{(string.IsNullOrEmpty(EnvironmentsBase) ? "environments/master/" : EnvironmentsBase)}locales/", etag, cancellationToken, null).ConfigureAwait(false);
772777

773778
if (!string.IsNullOrEmpty(etag) && res.Headers?.ETag?.Tag == etag)
774779
{
@@ -813,7 +818,7 @@ public async Task<SyncResult> SyncInitial(SyncType syncType = SyncType.All, stri
813818

814819
var query = BuildSyncQuery(syncType, contentTypeId, true, limit: limit);
815820

816-
var res = await Get($"{_baseUrl}{_options.SpaceId}/{EnvironmentsBase}sync{query}", "", cancellationToken, null).ConfigureAwait(false);
821+
var res = await Get($"{BaseUrl}{_options.SpaceId}/{EnvironmentsBase}sync{query}", "", cancellationToken, null).ConfigureAwait(false);
817822

818823
var syncResult = ParseSyncResult(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
819824

@@ -840,7 +845,7 @@ public async Task<SyncResult> SyncNextResult(string nextSyncOrPageUrl, Cancellat
840845

841846
var query = BuildSyncQuery(syncToken: syncToken);
842847

843-
var res = await Get($"{_baseUrl}{_options.SpaceId}/{EnvironmentsBase}sync{query}", "", cancellationToken, null).ConfigureAwait(false);
848+
var res = await Get($"{BaseUrl}{_options.SpaceId}/{EnvironmentsBase}sync{query}", "", cancellationToken, null).ConfigureAwait(false);
844849

845850
var syncResult = ParseSyncResult(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
846851

‎Contentful.Core/IContentfulClient.cs

+5
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,11 @@ public interface IContentfulClient
4242
/// </summary>
4343
List<CrossSpaceResolutionSetting> CrossSpaceResolutionSettings { get; set; }
4444

45+
/// <summary>
46+
/// The base url used when calling the Contentful services. Defaults to https://cdn.contentful.com/spaces/
47+
/// </summary>
48+
string BaseUrl { get; set; }
49+
4550
/// <summary>
4651
/// Get a single entry by the specified ID.
4752
/// </summary>

0 commit comments

Comments
 (0)