Proyectos de Subversion Iphone Microlearning

Rev

| Ultima modificación | Ver Log |

Rev Autor Línea Nro. Línea
1 efrain 1 
//
2 
//  RedirectHandler.swift
3 
//
4 
//  Copyright (c) 2014-2018 Alamofire Software Foundation (http://alamofire.org/)
5 
//
6 
//  Permission is hereby granted, free of charge, to any person obtaining a copy
7 
//  of this software and associated documentation files (the "Software"), to deal
8 
//  in the Software without restriction, including without limitation the rights
9 
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 
//  copies of the Software, and to permit persons to whom the Software is
11 
//  furnished to do so, subject to the following conditions:
12 
//
13 
//  The above copyright notice and this permission notice shall be included in
14 
//  all copies or substantial portions of the Software.
15 
//
16 
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 
//  THE SOFTWARE.
23 
//
24 
 
25 
import Foundation
26 
 
27 
/// A type that handles how an HTTP redirect response from a remote server should be redirected to the new request.
28 
public protocol RedirectHandler {
29 
    /// Determines how the HTTP redirect response should be redirected to the new request.
30 
    ///
31 
    /// The `completion` closure should be passed one of three possible options:
32 
    ///
33 
    ///   1. The new request specified by the redirect (this is the most common use case).
34 
    ///   2. A modified version of the new request (you may want to route it somewhere else).
35 
    ///   3. A `nil` value to deny the redirect request and return the body of the redirect response.
36 
    ///
37 
    /// - Parameters:
38 
    ///   - task:       The `URLSessionTask` whose request resulted in a redirect.
39 
    ///   - request:    The `URLRequest` to the new location specified by the redirect response.
40 
    ///   - response:   The `HTTPURLResponse` containing the server's response to the original request.
41 
    ///   - completion: The closure to execute containing the new `URLRequest`, a modified `URLRequest`, or `nil`.
42 
    func task(_ task: URLSessionTask,
43 
              willBeRedirectedTo request: URLRequest,
44 
              for response: HTTPURLResponse,
45 
              completion: @escaping (URLRequest?) -> Void)
46 
}
47 
 
48 
// MARK: -
49 
 
50 
/// `Redirector` is a convenience `RedirectHandler` making it easy to follow, not follow, or modify a redirect.
51 
public struct Redirector {
52 
    /// Defines the behavior of the `Redirector` type.
53 
    public enum Behavior {
54 
        /// Follow the redirect as defined in the response.
55 
        case follow
56 
        /// Do not follow the redirect defined in the response.
57 
        case doNotFollow
58 
        /// Modify the redirect request defined in the response.
59 
        case modify((URLSessionTask, URLRequest, HTTPURLResponse) -> URLRequest?)
60 
    }
61 
 
62 
    /// Returns a `Redirector` with a `.follow` `Behavior`.
63 
    public static let follow = Redirector(behavior: .follow)
64 
    /// Returns a `Redirector` with a `.doNotFollow` `Behavior`.
65 
    public static let doNotFollow = Redirector(behavior: .doNotFollow)
66 
 
67 
    /// The `Behavior` of the `Redirector`.
68 
    public let behavior: Behavior
69 
 
70 
    /// Creates a `Redirector` instance from the `Behavior`.
71 
    ///
72 
    /// - Parameter behavior: The `Behavior`.
73 
    public init(behavior: Behavior) {
74 
        self.behavior = behavior
75 
    }
76 
}
77 
 
78 
// MARK: -
79 
 
80 
extension Redirector: RedirectHandler {
81 
    public func task(_ task: URLSessionTask,
82 
                     willBeRedirectedTo request: URLRequest,
83 
                     for response: HTTPURLResponse,
84 
                     completion: @escaping (URLRequest?) -> Void) {
85 
        switch behavior {
86 
        case .follow:
87 
            completion(request)
88 
        case .doNotFollow:
89 
            completion(nil)
90 
        case let .modify(closure):
91 
            let request = closure(task, request, response)
92 
            completion(request)
93 
        }
94 
    }
95 
}
96 
 
97 
#if swift(>=5.5)
98 
extension RedirectHandler where Self == Redirector {
99 
    /// Provides a `Redirector` which follows redirects. Equivalent to `Redirector.follow`.
100 
    public static var follow: Redirector { .follow }
101 
 
102 
    /// Provides a `Redirector` which does not follow redirects. Equivalent to `Redirector.doNotFollow`.
103 
    public static var doNotFollow: Redirector { .doNotFollow }
104 
 
105 
    /// Creates a `Redirector` which modifies the redirected `URLRequest` using the provided closure.
106 
    ///
107 
    /// - Parameter closure: Closure used to modify the redirect.
108 
    /// - Returns:           The `Redirector`.
109 
    public static func modify(using closure: @escaping (URLSessionTask, URLRequest, HTTPURLResponse) -> URLRequest?) -> Redirector {
110 
        Redirector(behavior: .modify(closure))
111 
    }
112 
}
113 
#endif