Merge pull request #11 from adborbas/adborbas/outputsize_param

Add outputsize param to daily adjusted timeseries

Author: adborbas

Sources/AlphaSwiftage/Private/AlphaVantageAPI/AlphaVantageAPI.swift

@@ -14,5 +14,6 @@ enum AlphaVantageAPI {
         case fromCurrency = "from_currency"
         case toCurrency = "to_currency"
         case keywords
+        case outputSize = "outputsize"
     }
 }

Sources/AlphaSwiftage/Private/AlphaVantageAPI/AlphaVantageRequestBuilder.swift

@@ -30,10 +30,11 @@ class AlphaVantageRequestBuilder {
         return request(for: parameters)
     }
 
-    func requestForDailyAdjustedTimeSeries(symbol: String) -> AlphaVantageRequest {
+    func requestForDailyAdjustedTimeSeries(symbol: String, outputSize: OutputSize) -> AlphaVantageRequest {
         var parameters = Parameters()
         parameters.appendFunction(.dailyAdjustedTimeSeries)
         parameters.appendParameter(.symbol, value: symbol)
+        parameters.appendParameter(.outputSize, value: outputSize.parameterValue)
         return request(for: parameters)
     }
 
@@ -52,6 +53,7 @@ class AlphaVantageRequestBuilder {
         case fromCurrency = "from_currency"
         case toCurrency = "to_currency"
         case keywords
+        case outputSize = "outputsize"
     }
 }
 
@@ -70,3 +72,12 @@ fileprivate extension Parameters {
         }
     }
 }
+
+fileprivate extension OutputSize {
+    var parameterValue: String {
+        switch self {
+        case .compact: return "compact"
+        case .full: return "full"
+        }
+    }
+}

Sources/AlphaSwiftage/Public/AlphaVantageService.swift

@@ -38,11 +38,15 @@ public class AlphaVantageService {
             .serializingAlphaVantageWrappedResponse(SearchSymbolResponse.self) { $0.matches }
     }
 
-    public func dailyAdjustedTimeSeries(for symbol: String) async -> Result<[String: EquityDailyData], AlphaVantageError> {
-        let request = requestBuilder.requestForDailyAdjustedTimeSeries(symbol: symbol)
+    public func dailyAdjustedTimeSeries(for symbol: String, outputSize: OutputSize) async -> Result<[String: EquityDailyData], AlphaVantageError> {
+        let request = requestBuilder.requestForDailyAdjustedTimeSeries(symbol: symbol, outputSize: outputSize)
         return await session.request(request)
             .serializingAlphaVantageWrappedResponse(TimeSeriesResponse.self) { $0.dailyTimeSeries }
     }
+    
+    public func dailyAdjustedTimeSeries(for symbol: String) async -> Result<[String: EquityDailyData], AlphaVantageError> {
+        await dailyAdjustedTimeSeries(for: symbol, outputSize: .compact)
+    }
 }
 
 extension Session {

Sources/AlphaSwiftage/Public/OutputSize.swift

@@ -0,0 +1,4 @@
+public enum OutputSize {
+    case compact
+    case full
+}

Tests/AlphaVantageRequestBuilderTestCase.swift

@@ -59,13 +59,14 @@ class AlphaVantageRequestBuilderTestCase: XCTestCase {
         // Given
         let parameters: [String: Any] = [
             "function": "TIME_SERIES_DAILY_ADJUSTED",
-            "symbol": "APPL"
+            "symbol": "APPL",
+            "outputsize": "full"
         ]
         let expectedRequest = givenRequest(with: parameters)
         let requestBuilder = givenAlphaVantageRequestBuilder()
 
         // When
-        let actualRequest = requestBuilder.requestForDailyAdjustedTimeSeries(symbol: "APPL")
+        let actualRequest = requestBuilder.requestForDailyAdjustedTimeSeries(symbol: "APPL", outputSize: .full)
 
         // Then
         XCTAssertEqual(expectedRequest, actualRequest)

Tests/AlphaVantageServiceTests.swift

@@ -99,7 +99,7 @@ final class AlphaVantageServiceTests: XCTestCase {
 
         let symbol = "MSFT"
         let service = givenService()
-        given(response: .dailyTimeSeriesSuccess, for: "\(mockAPIHost.absoluteBaseURL)?function=TIME_SERIES_DAILY_ADJUSTED&symbol=\(symbol)")
+        given(response: .dailyTimeSeriesSuccess, for: "\(mockAPIHost.absoluteBaseURL)?function=TIME_SERIES_DAILY_ADJUSTED&outputsize=compact&symbol=\(symbol)")
 
         // When
         let result = await service.dailyAdjustedTimeSeries(for: symbol)