Swiftpack.co - neothXT/CombineNetworking as Swift Package

Swiftpack.co is a collection of thousands of indexed Swift packages. Search packages.
See all packages published by neothXT.
neothXT/CombineNetworking 1.3.0
Easy approach on Networking using Combine
⭐️ 5
🕓 4 days ago
iOS macOS
.package(url: "https://github.com/neothXT/CombineNetworking.git", from: "1.3.0")

CombineNetworking

Meet CombineNetworking. Super lightweight and crazy easy to use framework to help you create and handle your network requests in a convenient way. Besides basic network requests, CombineNetworking allows you to easily send your requests securely with a simple SSL and Certificate pinning mechanisms. But that's not all. With CombineNetworking you can also effortlessly handle authorization tokens with built-in automatic authorization mechanism.

Installation (using CocoaPods)

pod 'CombineNetworking'

Note that in order to use CombineNetworking, your iOS Deployment Target has to be 13.0 or newer. If you code for macOS, your Deployment Target has to be 10.15 or newer.

CombineNetworking is also available via SPM (Swift Package Manager)

Key functionalities

  • Sending requests easily using Endpoint models
  • SSL and Certificate pinning with just 2 lines of code
  • WebSocket connection support with CNWebSocket
  • Secure access token storage with KeyChain (thanks to KeychainAccess framework)
  • Access token storing strategy - configure global, endpoint specific (default) or custom strategy for all or just some endpoints
  • Automated refresh token/callback requests

Usage

Create an Endpoint to work with

enum TodosEndpoint {
  case todos(Int)
}

extension TodosEndpoint: Endpoint {
  var baseURL: URL? {
    URL(string: "https://jsonplaceholder.typicode.com/")
  }
	
  var path: String {
    switch self {
      case .todos:
      return "todos"
    }
  }
	
  var method: RequestMethod {
    .get
  }
	
  var headers: [String : Any]? {
    nil
  }
	
  var data: EndpointData {
    switch self {
      case .todos(let id):
      return .queryParams(["id": id])
    }
  }
}

RequestMethod is an enum with following options: .get, .post, .put, .delete. EndpointData is also an enum with following options:

  • .plain
  • .queryParams([String: Any])
  • .bodyParams([String: Any]) - takes Dictionary and parses it into Data to send in request's body
  • .urlEncoded([String: Any]) - takes Dictionary and parses it into String and then Data to send in request's body (to use with Content-Type: application/x-www-form-urlencoded)
  • .jsonModel(Encodable) - similar to .dataParams except this one takes Encodable and parses it into Data to send in request's body

Enable SSL and/or Certificate pinning (optional)

//First - turn pinning on
CNConfig.pinningModes = [.ssl, .certificate]

Please remember that SSL/Certificate pinning requires certificate file to be attached in your project. Certificates and SSL keys are autmatically loaded by CombineNetworking.

Automatic authorization mechanism

Handling authorization callbacks with CombineNetworking is ridiculously easy. To use it with your Endpoint all you have to do is the following:


enum TodosEndpoint {
  case token
  case todos(Int)
}

extension TodosEndpoint: Endpoint {
  //Setup all the required properties like baseURL, path, etc...
		
  //... then determine which of your endpoints require authorization...
  var requiresAccessToken: Bool {
    switch self {
    case .token:
      return false
     
    default:
      return true
    }
  }
	
  //... and prepare callbackPublisher to handle authorization callbacks
  var callbackPublisher: AnyPublisher<AccessTokenConvertible?, Error>? {
    try? CNProvider<TodosEndpoint>().publisher(for: .token, responseType: CNAccessToken?.self).asAccessTokenConvertible()
  }
}

See? Easy peasy!

PS: You can also store access tokens manually using CNConfig.setAccessToken(_ token: CNAccessToken?, for endpoint: Endpoint)

Access Token Strategies

CombineNetworking allows you to specify access token strategies globally as well as individually for each endpoint. You can specify your strategy by setting it for CNConfig.defaultAccessTokenStrategy or inside your Endpoint by setting value for field accessTokenStrategy. Available options are:

  • .global - uses global label to store access token
  • .default - uses endpoint identifiers as labels to store access tokens
  • .custom(String) - with this option you can specify your own label to store access token and use it among as many endpoints as you wish

Thanks to access token strategy being set both globally (via CNConfig) and individually (inside Endpoint), you can mix different strategies in your app!

Safe storage using Keychain

CombineNetworking allows you to store your access tokens in keychain. This feature is turned on by default. Using keychain to store your access keys requires you to provide keychain instance by setting value of CNConfig.keychainInstance. Safe storage using keychain can be disabled by toggling CNConfig.storeTokensInKeychain option.

WebSockets

CombineNetworking also allows you to connect with WebSockets effortlessly. Simply use CNWebSocket like this:

let webSocket = CNWebSocket(url: URL(string: "wss://socketsbay.com/wss/v2/2/demo/")!)
webSocket.connect()
webSocket.listen { result in
	switch result {
	case .success(let message):
		switch message {
		case .data(let data):
			print("Received binary: \(data)")
		case .string(let string):
			print("Received string: \(string)")
		}
	default:
		return
	}
}
webSocket.send(URLSessionWebSocketTask.Message.string("Test message")) {
	if let error = $0 {
		log(error.localizedDescription)
	}
}

If you want to close connection, just call webSocket.disconnect().

Subscribe to a publisher

private var subscriptions: Set<AnyCancellable> = []
var todo: Todo?

func subscribeForTodos() {
  CNProvider<TodosEndpoint>().publisher(for: .todos(1), responseType: Todo?.self)
    .catch { (error) -> Just<Todo?> in
      print(error)
      return Just(nil)
    }
    .assign(to: \.todo, on: self)
    .store(in: &subscriptions)
}

And that's it. Enjoy :)

GitHub

link
Stars: 5
Last commit: 4 days ago
jonrohan Something's broken? Yell at me @ptrpavlik. Praise and feedback (and money) is also welcome.

Related Packages

Release Notes

Release 1.3.0
4 days ago

This release contains automatic SSL keys and certificates loading functionalities

Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics