Merge pull request #1 from masture/main

NodeZooSDK (v1.0.1)

Author: rjrodger

.gitignore

@@ -88,3 +88,4 @@ fastlane/test_output
 # https://github.com/johnno1962/injectionforxcode
 
 iOSInjectionProject/
+contents.xcworkspacedata

Package.swift

@@ -0,0 +1,29 @@
+// swift-tools-version: 5.7
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "NodeZooSDK",
+    platforms: [.iOS(.v14)],
+    products: [
+        // Products define the executables and libraries a package produces, and make them visible to other packages.
+        .library(
+            name: "NodeZooSDK",
+            targets: ["NodeZooSDK"]),
+    ],
+    dependencies: [
+        // Dependencies declare other packages that this package depends on.
+        // .package(url: /* package url */, from: "1.0.0"),
+    ],
+    targets: [
+        // Targets are the basic building blocks of a package. A target can define a module or a test suite.
+        // Targets can depend on other targets in this package, and on products in packages this package depends on.
+        .target(
+            name: "NodeZooSDK",
+            dependencies: []),
+        .testTarget(
+            name: "NodeZooSDKTests",
+            dependencies: ["NodeZooSDK"]),
+    ]
+)

README.md

@@ -1,2 +1,32 @@
-# ios-sdk
-iOS SDK for nodezoon
+# NodeZooSDK
+
+An iOS SDK for nodezoo to search the public packaged from [https://nodezoo.com/](https://nodezoo.com/)
+
+## NodeZooService Initializer with API Key
+
+```swift
+import NodeZooService
+
+let nodeZooService = NodeZooService(apiKey: "<API Key of >")
+```
+
+This initializer creates a 'NodeZooService` instance.
+
+### Parameters
+
+- `apiKey`: API Key to search packages from [nodezoo.com](nodezoo.com)
+
+### Usage
+
+Search the public package as follows:
+```swift
+let dataTask = nodeZooService.search("express") { result in
+    switch result {
+    case .success(let packages):
+        // packages is the array of the found packages
+    case .failure(let error):
+        // handle the error here.
+}
+```
+The *dataTask* can be used to cancel the search.
+

Sources/NodeZooSDK/Internal/APIService.swift

@@ -0,0 +1,62 @@
+//
+//  APIService.swift
+//  
+//
+//  Created by Pankaj Kulkarni on 09/05/23.
+//
+
+import Foundation
+
+protocol APIServicingClosure {
+    func search(request: URLRequest, completion: @escaping (Result<[NZPackage], Error>)->Void) -> URLSessionDataTask?
+}
+
+struct ClosureBasedAPIService: APIServicingClosure {
+    
+    var urlSession = URLSession.shared
+
+    
+    func search(request: URLRequest, completion: @escaping (Result<[NZPackage], Error>) -> Void) -> URLSessionDataTask? {
+        
+        let dataTask = urlSession.dataTask(with: request) {data, response, error in
+            print("Received response")
+            guard let httpResponse = response as? HTTPURLResponse else {
+                completion(.failure(NodeZooServiceError.invalidResponse))
+                return
+            }
+            
+            // --- Debugging purpose only ---
+            #if DEBUG
+            print("Status code: \(httpResponse.statusCode)")
+            if let data = data {
+                print("Data: \(String(describing: String(data: data, encoding: .utf8)))")
+            }
+            #endif
+                        
+            guard httpResponse.statusCode == 200 else {
+                completion(.failure(NodeZooServiceError.serverError))
+                return
+            }
+            
+            guard let data = data else {
+                completion(.failure(NodeZooServiceError.noData))
+                return
+            }
+            
+            do {
+                let searchResponse = try JSONDecoder().decode(SearchResponse.self, from: data)
+                if searchResponse.ok {
+                    completion(.success(searchResponse.data?.packages ?? []))
+                } else {
+                    completion(.failure(NodeZooServiceError.nonOkResponse))
+                }
+            } catch {
+                completion(.failure(error))
+            }
+        }
+        dataTask.resume()
+        return dataTask
+    }
+    
+    
+}

Sources/NodeZooSDK/Internal/Models/SearchRequest.swift

@@ -0,0 +1,27 @@
+//
+//  SearchRequest.swift
+//  
+//
+//  Created by Pankaj Kulkarni on 09/05/23.
+//
+
+import Foundation
+
+// MARK: - SearchRequest
+internal struct SearchRequest: Encodable {
+    let role = "web", scope = "public", search = "pkgs"
+    let prefix: String
+    
+    var body: Data? {
+        var encodedData: Data? = nil
+        do {
+            encodedData = try JSONEncoder().encode(self)
+        } catch {
+            print("Error encoding: \(error)")
+        }
+        return encodedData
+    }
+    
+}
+
+

Sources/NodeZooSDK/Internal/Models/SearchResponse.swift

@@ -0,0 +1,45 @@
+//
+//  SearchResponse.swift
+//  
+//
+//  Created by Pankaj Kulkarni on 09/05/23.
+//
+
+import Foundation
+
+// MARK: - SearchResponse
+internal struct SearchResponse: Codable {
+    let ok: Bool
+    let why: String?
+    let details: Details?
+    let data: DataClass?
+    let meta: Meta
+
+    enum CodingKeys: String, CodingKey {
+        case ok, data, why, details
+        case meta = "meta$"
+    }
+}
+
+internal struct Details: Codable {
+    let path: [String]
+    let whyExactly: String
+    
+    enum CodingKeys: String, CodingKey {
+        case path
+        case whyExactly = "why_exactly"
+    }
+}
+
+// MARK: - DataClass
+internal struct DataClass: Codable {
+    let packages: [NZPackage]
+    enum CodingKeys: String, CodingKey {
+        case packages = "pkgs"
+    }
+}
+
+// MARK: - Meta
+internal struct Meta: Codable {
+    let id: String
+}

Sources/NodeZooSDK/Internal/NetworkManager.swift

@@ -0,0 +1,50 @@
+//
+//  NetworkManager.swift
+//  
+//
+//  Created by Pankaj Kulkarni on 09/05/23.
+//
+
+import Foundation
+
+struct NetworkManager {
+    
+    let apiKey: String
+    let apiService: APIServicingClosure
+    
+    init(apiKey: String, apiService: APIServicingClosure = ClosureBasedAPIService()) {
+        self.apiKey = apiKey
+        self.apiService = apiService
+    }
+    
+    @discardableResult
+    func search(package: String, completion: @escaping (Result<[NZPackage], Error>)->Void) -> URLSessionDataTask? {
+        print("Searching for: \(package)")
+        guard var request = createRequest() else {
+            print("Invalid Request")
+            completion(.failure(NodeZooServiceError.invalidRequest))
+            return nil
+        }
+        let searchRequest = SearchRequest(prefix: package)
+        print("Search request: \(searchRequest)")
+        
+        request.httpBody = searchRequest.body
+        
+        return apiService.search(request: request, completion: completion)
+        
+    }
+    
+    func createRequest(urlString: String = "https://api.nodezoo.com/api/public") -> URLRequest? {
+        guard let url = URL(string: urlString) else {
+            print("Invalid URL")
+            return nil
+        }
+        
+        var request = URLRequest(url: url)
+        request.addValue("Bearer \(apiKey)", forHTTPHeaderField: "Authorization")
+        request.addValue("application/json; charset=utf-8", forHTTPHeaderField: "Content-Type")
+        request.httpMethod = "POST"
+        return request
+    }
+    
+}

Sources/NodeZooSDK/public/NZPackage.swift

@@ -0,0 +1,19 @@
+//
+//  NZPackage.swift
+//  
+//
+//  Created by Pankaj Kulkarni on 09/05/23.
+//
+
+import Foundation
+
+
+/// This struct contains the details of the NodeJS packages
+public struct NZPackage: Codable {
+    /// Name of the package
+    public let name: String
+    /// version of the package
+    public let version: String
+    /// Description of the package
+    public let desc: String
+}

Sources/NodeZooSDK/public/NodeZooService.swift

@@ -0,0 +1,53 @@
+//
+//  NodeZooService.swift
+//  
+//
+//  Created by Pankaj Kulkarni on 09/05/23.
+//
+
+import Foundation
+
+/// Use NodeZooService to fetch the public search function of [nodezoo.com](nodezoo.com)
+///
+/// While instantiating the ``NodeZooService`` instance pass the API Key as follows:
+/// ```
+///import NodeZooService
+///
+///let nodeZooService = NodeZooService(apiKey: "<API Key of >")
+/// ```
+///
+/// And then search the public package as follows:
+///
+/// ```
+/// let dataTask = nodeZooService.search("express") { result in
+/// switch result {
+/// case .success(let packages):
+///     // packages is the array of the found packages
+/// case .failure(let error):
+///     // handle the error here.
+/// }
+/// ```
+/// The *dataTask* can be used to cancel the search.
+///
+public class NodeZooService {
+    
+    private var networkManager: NetworkManager
+    
+    /// Initializer of NodeZooService
+    /// - Parameter apiKey: API Key to search packages from [nodezoo.com](nodezoo.com)
+    public init(apiKey: String) {
+        networkManager = NetworkManager(apiKey: apiKey)
+    }
+    
+    /// Search the packages
+    /// - Parameters:
+    ///   - query: The query string to search for.
+    ///   - completion: The completion will be invoked with either success or failure.
+    /// - Returns: Discardable data task. This can be used to cancel the search.
+    ///
+    @discardableResult
+    public func search(query: String, completion: @escaping (Result<[NZPackage], Error>)->Void) -> URLSessionDataTask? {
+        return networkManager.search(package: query, completion: completion)
+    }
+    
+}

Sources/NodeZooSDK/public/NodeZooServiceError.swift

@@ -0,0 +1,24 @@
+//
+//  NodeZooServiceError.swift
+//  
+//
+//  Created by Pankaj Kulkarni on 09/05/23.
+//
+
+import Foundation
+
+/// The error returned by the ``NodeZooService/search(query:completion:)`` function
+///
+/// The ``NodeZooService`` will return one of these errors or Error when unable to decode the response.
+public enum NodeZooServiceError: Error {
+    /// Invalid request - Should never happen – report to the package creator.
+    case invalidRequest
+    /// The HTTP Response is invalid
+    case invalidResponse
+    /// No data received
+    case noData
+    /// Non-success (200) response
+    case serverError
+    /// Success by not OK response
+    case nonOkResponse
+}