Modernize StripeConfiguration

readme.md

@@ -35,7 +35,7 @@ You can configure the Stripe.net package to use your secret API key in one of tw
 a) In your application initialization, set your API key (only once once during startup):
 
 ```csharp
-StripeConfiguration.SetApiKey("[your api key here]");
+StripeConfiguration.ApiKey = "[your api key here]";
 ```
 
 b) Pass the API key to [RequestOptions](#requestoptions):

src/Stripe.net/Infrastructure/Client.cs

@@ -8,7 +8,7 @@ namespace Stripe.Infrastructure
     using Newtonsoft.Json;
 #if NET45
     using Microsoft.Win32;
-    #else
+#else
     using System.Runtime.InteropServices;
 #endif
 

src/Stripe.net/Infrastructure/JsonConverters/EventConverter.cs

@@ -8,7 +8,7 @@ namespace Stripe.Infrastructure
     /// <summary>
     /// This converter is used to deserialize event objects regardless of which API version they're
     /// formatted with. In the general case, Stripe.net uses a specific API version
-    /// (<see cref="StripeConfiguration.StripeApiVersion"/>), but events are a special case: when
+    /// (<see cref="StripeConfiguration.ApiVersion"/>), but events are a special case: when
     /// receiving an event object via a webhook notification, the object will be formatted with
     /// the Stripe account's default API version which may be different than Stripe.net's API
     /// version.

src/Stripe.net/Infrastructure/Public/StripeConfiguration.cs

@@ -7,117 +7,107 @@ namespace Stripe
     using Newtonsoft.Json;
     using Stripe.Infrastructure;
 
+    /// <summary>
+    /// Global configuration class for Stripe.net settings.
+    /// </summary>
     public static class StripeConfiguration
     {
-        private static string stripeApiVersion = "2018-11-08";
-
         private static string apiKey;
-        private static string apiBase;
-        private static string connectBase;
-        private static string filesBase;
-        private static JsonSerializerSettings serializerSettings = DefaultSerializerSettings();
 
         static StripeConfiguration()
         {
             StripeNetVersion = new AssemblyName(typeof(Requestor).GetTypeInfo().Assembly.FullName).Version.ToString(3);
         }
 
-        public static string StripeApiVersion
-        {
-            get { return stripeApiVersion; }
-            set { stripeApiVersion = value; }
-        }
+        /// <summary>API version used by Stripe.net.</summary>
+        public static string ApiVersion => "2018-11-08";
 
-        /// <summary>
-        /// Gets or sets the settings used for deserializing JSON objects returned by Stripe's API.
-        /// It is highly recommended you do not change these settings, as doing so can produce
-        /// unexpected results. If you do change these settings, make sure that
-        /// <see cref="Stripe.Infrastructure.StripeObjectConverter"/> is among the converters,
-        /// otherwise the library will no longer be able to deserialize polymorphic resources
-        /// represented by interfaces (e.g. <see cref="IPaymentSource"/>).
-        /// </summary>
-        public static JsonSerializerSettings SerializerSettings
-        {
-            get { return serializerSettings; }
-            set { serializerSettings = value; }
-        }
+        /// <summary>Default base URL for Stripe's API.</summary>
+        public static string DefaultApiBase => "https://api.stripe.com";
 
-        public static string StripeNetVersion { get; }
+        /// <summary>Default base URL for Stripe's OAuth API.</summary>
+        public static string DefaultConnectBase => "https://connect.stripe.com";
 
-        /// <summary>
-        /// This option allows you to provide your own HttpMessageHandler. Useful with Android/iPhone.
-        /// </summary>
-        public static HttpMessageHandler HttpMessageHandler { get; set; }
+        /// <summary>Default base URL for Stripe's Files API.</summary>
+        public static string DefaultFilesBase => "https://files.stripe.com";
+
+        /// <summary>Default timespan before the request times out.</summary>
+        public static TimeSpan DefaultHttpTimeout => new TimeSpan(80 * TimeSpan.TicksPerSecond);
 
-        public static TimeSpan? HttpTimeSpan { get; set; }
+        /// <summary>Gets or sets the base URL for Stripe's API.</summary>
+        public static string ApiBase { get; set; } = DefaultApiBase;
 
-        internal static string GetApiKey()
+#if NET45 || NETSTANDARD2_0
+        /// <summary>Gets or sets the API key.</summary>
+        /// <remarks>
+        /// You can also set the API key using the <c>StripeApiKey</c> key in
+        /// <see cref="System.Configuration.ConfigurationManager.AppSettings"/>.
+        /// </remarks>
+#else
+        /// <summary>Gets or sets the API key.</summary>
+#endif
+        public static string ApiKey
         {
-#if NET45
-            if (string.IsNullOrEmpty(apiKey))
+            get
             {
-                apiKey = System.Configuration.ConfigurationManager.AppSettings["StripeApiKey"];
-            }
+#if NET45 || NETSTANDARD2_0
+                if (string.IsNullOrEmpty(apiKey))
+                {
+                    apiKey = System.Configuration.ConfigurationManager.AppSettings["StripeApiKey"];
+                }
 #endif
+                return apiKey;
+            }
 
-            return apiKey;
-        }
-
-        public static void SetApiKey(string newApiKey)
-        {
-            apiKey = newApiKey;
-        }
-
-        internal static string GetApiBase()
-        {
-            if (string.IsNullOrEmpty(apiBase))
+            set
             {
-                apiBase = Urls.DefaultBaseUrl;
+                apiKey = value;
             }
-
-            return apiBase;
         }
 
-        public static void SetApiBase(string baseUrl)
-        {
-            apiBase = baseUrl;
-        }
+        /// <summary>Gets or sets the base URL for Stripe's OAuth API.</summary>
+        public static string ConnectBase { get; set; } = DefaultConnectBase;
 
-        internal static string GetConnectBase()
-        {
-            if (string.IsNullOrEmpty(connectBase))
-            {
-                connectBase = Urls.DefaultBaseConnectUrl;
-            }
+        /// <summary>Gets or sets the base URL for Stripe's Files API.</summary>
+        public static string FilesBase { get; set; } = DefaultFilesBase;
 
-            return connectBase;
-        }
+        /// <summary>Gets or sets a custom <see cref="HttpMessageHandler"/>.</summary>
+        public static HttpMessageHandler HttpMessageHandler { get; set; }
 
-        public static void SetConnectBase(string baseUrl)
-        {
-            connectBase = baseUrl;
-        }
+        /// <summary>Gets or sets the timespan to wait before the request times out.</summary>
+        public static TimeSpan HttpTimeout { get; set; } = DefaultHttpTimeout;
 
-        internal static string GetFilesBase()
-        {
-            if (string.IsNullOrEmpty(filesBase))
-            {
-                filesBase = Urls.DefaultBaseFilesUrl;
-            }
+        /// <summary>
+        /// Gets or sets the settings used for deserializing JSON objects returned by Stripe's API.
+        /// It is highly recommended you do not change these settings, as doing so can produce
+        /// unexpected results. If you do change these settings, make sure that
+        /// <see cref="Stripe.Infrastructure.StripeObjectConverter"/> is among the converters,
+        /// otherwise Stripe.net will no longer be able to deserialize polymorphic resources
+        /// represented by interfaces (e.g. <see cref="IPaymentSource"/>).
+        /// </summary>
+        public static JsonSerializerSettings SerializerSettings { get; set; } = DefaultSerializerSettings();
 
-            return filesBase;
-        }
+        /// <summary>Gets the version of the Stripe.net client library.</summary>
+        public static string StripeNetVersion { get; }
 
-        public static void SetFilesBase(string baseUrl)
+        /// <summary>
+        /// Gets or sets the timespan to wait before the request times out.
+        /// This property is deprecated and will be removed in a future version, please use the
+        /// <see cref="HttpTimeout"/> property instead.
+        /// </summary>
+        // TODO: remove this property in a future major version
+        [Obsolete("Use StripeConfiguration.HttpTimeout instead.")]
+        public static TimeSpan? HttpTimeSpan
         {
-            filesBase = baseUrl;
+            get { return HttpTimeout; }
+            set { HttpTimeout = value ?? DefaultHttpTimeout; }
         }
 
         /// <summary>
         /// Returns a new instance of <see cref="Newtonsoft.Json.JsonSerializerSettings"/> with
         /// the default settings used by Stripe.net.
         /// </summary>
-        /// <returns>A <see cref="Newtonsoft.Json.JsonSerializerSettings"/> instance</returns>
+        /// <returns>A <see cref="Newtonsoft.Json.JsonSerializerSettings"/> instance.</returns>
         public static JsonSerializerSettings DefaultSerializerSettings()
         {
             return new JsonSerializerSettings
@@ -129,5 +119,55 @@ public static JsonSerializerSettings DefaultSerializerSettings()
                 DateParseHandling = DateParseHandling.None,
             };
         }
+
+        // TODO: remove everything below this in a future major version
+
+        /// <summary>
+        /// Sets the base URL.for Stripe's API.
+        /// This method is deprecated and will be removed in a future version, please use the
+        /// <see cref="ApiBase"/> property setter instead.
+        /// </summary>
+        /// <param name="baseUrl">Base URL.for Stripe's API.</param>
+        [Obsolete("Use StripeConfiguration.ApiBase getter instead.")]
+        public static void SetApiBase(string baseUrl)
+        {
+            ApiBase = baseUrl;
+        }
+
+        /// <summary>
+        /// Sets the API key.
+        /// This method is deprecated and will be removed in a future version, please use the
+        /// <see cref="ApiKey"/> property setter instead.
+        /// </summary>
+        /// <param name="newApiKey">API key.</param>
+        [Obsolete("Use StripeConfiguration.ApiKey setter instead.")]
+        public static void SetApiKey(string newApiKey)
+        {
+            ApiKey = newApiKey;
+        }
+
+        /// <summary>
+        /// Sets the base URL.for Stripe's OAuth API.
+        /// This method is deprecated and will be removed in a future version, please use the
+        /// <see cref="ConnectBase"/> property setter instead.
+        /// </summary>
+        /// <param name="baseUrl">Base URL.for Stripe's OAuth API.</param>
+        [Obsolete("Use StripeConfiguration.ConnectBase setter instead.")]
+        public static void SetConnectBase(string baseUrl)
+        {
+            ConnectBase = baseUrl;
+        }
+
+        /// <summary>
+        /// Sets the base URL.for Stripe's Files API.
+        /// This method is deprecated and will be removed in a future version, please use the
+        /// <see cref="FilesBase"/> property setter instead.
+        /// </summary>
+        /// <param name="baseUrl">Base URL.for Stripe's Files API.</param>
+        [Obsolete("Use StripeConfiguration.FilesBase setter instead.")]
+        public static void SetFilesBase(string baseUrl)
+        {
+            FilesBase = baseUrl;
+        }
     }
 }

src/Stripe.net/Infrastructure/Requestor.cs

@@ -20,10 +20,7 @@ static Requestor()
                     ? new HttpClient(StripeConfiguration.HttpMessageHandler)
                     : new HttpClient();
 
-            if (StripeConfiguration.HttpTimeSpan.HasValue)
-            {
-                HttpClient.Timeout = StripeConfiguration.HttpTimeSpan.Value;
-            }
+            HttpClient.Timeout = StripeConfiguration.HttpTimeout;
         }
 
         internal static HttpClient HttpClient { get; private set; }
@@ -120,7 +117,7 @@ private static StripeResponse ExecuteRequest(HttpRequestMessage requestMessage)
 
         internal static HttpRequestMessage GetRequestMessage(string url, HttpMethod method, RequestOptions requestOptions)
         {
-            requestOptions.ApiKey = requestOptions.ApiKey ?? StripeConfiguration.GetApiKey();
+            requestOptions.ApiKey = requestOptions.ApiKey ?? StripeConfiguration.ApiKey;
 
 #if NET45
             ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12 | SecurityProtocolType.Tls11 | SecurityProtocolType.Tls;
@@ -148,7 +145,7 @@ internal static HttpRequestMessage GetRequestMessage(string url, HttpMethod meth
             }
             else
             {
-                request.Headers.Add("Stripe-Version", StripeConfiguration.StripeApiVersion);
+                request.Headers.Add("Stripe-Version", StripeConfiguration.ApiVersion);
             }
 
             var client = new Client(request);

src/Stripe.net/Services/Account/AccountService.cs

@@ -22,7 +22,7 @@ public AccountService(string apiKey)
         {
         }
 
-        public override string BasePath => "/accounts";
+        public override string BasePath => "/v1/accounts";
 
         public bool ExpandBusinessLogo { get; set; }
 
@@ -58,12 +58,12 @@ public virtual Account Get(string accountId, RequestOptions requestOptions = nul
 
         public virtual Account GetSelf(RequestOptions requestOptions = null)
         {
-            return this.GetRequest<Account>($"{Urls.BaseUrl}/account", null, requestOptions, false);
+            return this.GetRequest<Account>($"{StripeConfiguration.ApiBase}/v1/account", null, requestOptions, false);
         }
 
         public virtual Task<Account> GetSelfAsync(RequestOptions requestOptions = null, CancellationToken cancellationToken = default(CancellationToken))
         {
-            return this.GetRequestAsync<Account>($"{Urls.BaseUrl}/account", null, requestOptions, false, cancellationToken);
+            return this.GetRequestAsync<Account>($"{StripeConfiguration.ApiBase}/v1/account", null, requestOptions, false, cancellationToken);
         }
 
         public virtual StripeList<Account> List(AccountListOptions options = null, RequestOptions requestOptions = null)

src/Stripe.net/Services/AccountLinks/AccountLinkService.cs

@@ -19,7 +19,7 @@ public AccountLinkService(string apiKey)
         {
         }
 
-        public override string BasePath => "/account_links";
+        public override string BasePath => "/v1/account_links";
 
         public virtual AccountLink Create(AccountLinkCreateOptions options, RequestOptions requestOptions = null)
         {

src/Stripe.net/Services/ApplePayDomains/ApplePayDomainService.cs

@@ -20,7 +20,7 @@ public ApplePayDomainService(string apiKey)
         {
         }
 
-        public override string BasePath => "/apple_pay/domains";
+        public override string BasePath => "/v1/apple_pay/domains";
 
         public virtual ApplePayDomain Create(ApplePayDomainCreateOptions options, RequestOptions requestOptions = null)
         {

src/Stripe.net/Services/ApplicationFeeRefunds/ApplicationFeeRefundService.cs

@@ -20,7 +20,7 @@ public ApplicationFeeRefundService(string apiKey)
         {
         }
 
-        public override string BasePath => "/application_fees/{PARENT_ID}/refunds";
+        public override string BasePath => "/v1/application_fees/{PARENT_ID}/refunds";
 
         public bool ExpandBalanceTransaction { get; set; }
 

src/Stripe.net/Services/ApplicationFees/ApplicationFeeService.cs

@@ -18,7 +18,7 @@ public ApplicationFeeService(string apiKey)
         {
         }
 
-        public override string BasePath => "/application_fees";
+        public override string BasePath => "/v1/application_fees";
 
         public bool ExpandAccount { get; set; }
 

src/Stripe.net/Services/Balance/BalanceService.cs

@@ -19,7 +19,7 @@ public BalanceService(string apiKey)
         {
         }
 
-        public override string BasePath => "/balance";
+        public override string BasePath => "/v1/balance";
 
         public virtual Balance Get(RequestOptions requestOptions = null)
         {

src/Stripe.net/Services/BalanceTransactions/BalanceTransactionService.cs

@@ -18,7 +18,7 @@ public BalanceTransactionService(string apiKey)
         {
         }
 
-        public override string BasePath => "/balance/history";
+        public override string BasePath => "/v1/balance/history";
 
         public bool ExpandSource { get; set; }